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

Refactor documentation #278

Merged
merged 26 commits into from
Sep 3, 2020
Merged

Refactor documentation #278

merged 26 commits into from
Sep 3, 2020

Conversation

maxulysse
Copy link
Member

@maxulysse maxulysse commented Sep 1, 2020

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

  • 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 necessary, also make a PR on the nf-core/sarek branch on the nf-core/test-datasets repo
  • Ensure the test suite passes (nextflow run . -profile test,docker).
  • Make sure your code lints (nf-core lint .).
  • Documentation in docs is updated
  • CHANGELOG.md is updated
  • README.md is updated

Learn more about contributing: CONTRIBUTING.md

@maxulysse maxulysse added the docs label Sep 1, 2020
@maxulysse maxulysse added this to the 2.6.2 milestone Sep 1, 2020
@maxulysse maxulysse requested a review from a team September 1, 2020 13:33
@maxulysse maxulysse changed the title Update documentation Refactor documentation Sep 1, 2020
Copy link
Contributor

@FriederikeHanssen FriederikeHanssen left a 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 :)

containers/vep/Dockerfile Show resolved Hide resolved
docs/usage.md Show resolved Hide resolved
docs/usage.md 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
docs/usage.md Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
docs/usage.md Show resolved Hide resolved
docs/output.md Outdated Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
docs/usage.md Outdated Show resolved Hide resolved
Copy link
Contributor

@FriederikeHanssen FriederikeHanssen left a 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

docs/output.md Outdated Show resolved Hide resolved
docs/output.md Outdated Show resolved Hide resolved
docs/output.md Outdated Show resolved Hide resolved
docs/output.md Show resolved Hide resolved
docs/output.md Outdated Show resolved Hide resolved
docs/output.md Show resolved Hide resolved
docs/output.md Show resolved Hide resolved
docs/output.md Outdated Show resolved Hide resolved
docs/output.md Show resolved Hide resolved
@@ -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.

Copy link
Contributor

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.

@maxulysse
Copy link
Member Author

@FriederikeHanssen I think I'm quite happy with the current state of the docs.
Thank you so much for all your help.

maxulysse and others added 2 commits September 3, 2020 13:21
@maxulysse maxulysse merged commit 522dbcd into nf-core:dev Sep 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants