-
Notifications
You must be signed in to change notification settings - Fork 421
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
Refactor documentation #278
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome! I also actually finally read all of the docs 😆
Haven't reviewed the output.md yet, but will submit comments anyways, so that they don't get lost. Hopefully I can finish it tonight. Otherwise in the morning :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Amazing! Just some minor things, some typos or missed quotes or so
@@ -665,7 +672,7 @@ For further reading and documentation see the [VEP manual](https://www.ensembl.o | |||
[MultiQC](http://multiqc.info) is a visualization tool that generates a single HTML report summarizing all samples in your project. | |||
Most of the pipeline QC results are visualised in the report and further statistics are available in the report data directory. | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it may be helpful to add which QC tools are NOT present in the MultiQC report.
@FriederikeHanssen I think I'm quite happy with the current state of the docs. |
Co-authored-by: FriederikeHanssen <[email protected]>
nf-core/sarek pull request
Closes #276
Many thanks for contributing to nf-core/sarek!
Please fill in the appropriate checklist below (delete whatever is not relevant).
These are the most common things requested on pull requests (PRs).
PR checklist
nextflow run . -profile test,docker
).nf-core lint .
).docs
is updatedCHANGELOG.md
is updatedREADME.md
is updatedLearn more about contributing: CONTRIBUTING.md