Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation updates #144

Merged
merged 11 commits into from
Oct 29, 2024
Merged

Documentation updates #144

merged 11 commits into from
Oct 29, 2024

Conversation

hemanoel
Copy link
Contributor

I have updated the README and usage files to fix typos, improve text clarity in some points, and provide more details about how to use phaseimpute.

PR checklist

  • This comment contains a description of changes (with reason).
  • If you've fixed a bug or added code that should be tested, add tests!
  • If you've added a new tool - have you followed the pipeline conventions in the contribution docs
  • If necessary, also make a PR on the nf-core/phaseimpute branch on the nf-core/test-datasets repository.
  • Make sure your code lints (nf-core pipelines lint).
  • Ensure the test suite passes (nextflow run . -profile test,docker --outdir <OUTDIR>).
  • Check for unexpected warnings in debug mode (nextflow run . -profile debug,test,docker --outdir <OUTDIR>).
  • Usage Documentation in docs/usage.md is updated.
  • Output Documentation in docs/output.md is updated.
  • CHANGELOG.md is updated.
  • README.md is updated (including new tool citations and authors/contributors).

Copy link
Collaborator

@LouisLeNezet LouisLeNezet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can add yourself in the Changelog and in the readme.

README.md Outdated Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
docs/usage.md Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
@LouisLeNezet LouisLeNezet added the documentation Improvements or additions to documentation label Oct 29, 2024
@LouisLeNezet LouisLeNezet added this to the v0.99.0 milestone Oct 29, 2024
@LouisLeNezet LouisLeNezet linked an issue Oct 29, 2024 that may be closed by this pull request
3 tasks
@atrigila
Copy link
Collaborator

Great job! Could you also fill in the changelog? :)

@hemanoel hemanoel merged commit a790ca1 into nf-core:dev Oct 29, 2024
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Check documentation for first release
3 participants