Closed priyanka-surana closed 2 years ago
Looks good to me. Just one thing: you've stated that this PR creates docs/results.md
and it's indeed empty. I guess that's because we don't have the actual variant-calling sub-workflows yet, so we don't know what outputs will be and where ?
Yes both output.md
and results.md
will be filled in as we go along with more subworkflows, this PR creates the necessary structure.
This starts the documentation by modifying
README.md
,docs/README.md
,docs/usage.md
anddocs/parameters.md
. It also creates the filedocs/results.md
Documentation tries to replicate pipeline pages on nf-core website. Example: https://nf-co.re/rnaseq
PR checklist
nf-core lint
).nextflow run . -profile test,docker --outdir <OUTDIR>
).docs/usage.md
is updated.docs/output.md
is updated.CHANGELOG.md
is updated.README.md
is updated (including new tool citations and authors/contributors).