Skip to content

Update usage docu for newcomers#1037

Draft
d4straub wants to merge 8 commits into
nf-core:devfrom
d4straub:update-docu-for-newcomers
Draft

Update usage docu for newcomers#1037
d4straub wants to merge 8 commits into
nf-core:devfrom
d4straub:update-docu-for-newcomers

Conversation

@d4straub
Copy link
Copy Markdown
Collaborator

This is a first proposal to make the usage documentation more friendly to scientists new to the field. It attempts to explain the defaults of the pipeline and when to deviate from them.
Up for discussion.

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/mag 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).

@jfy133
Copy link
Copy Markdown
Member

jfy133 commented May 27, 2026

@nf-core-bot fix linting

@jfy133 jfy133 linked an issue May 27, 2026 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create newcomer guidance documentation page

3 participants