Skip to content

update output docs with info about custom multiqc sections - #266

Open
pontushojer wants to merge 2 commits into
nf-core:devfrom
pontushojer:multiqc-docs
Open

update output docs with info about custom multiqc sections#266
pontushojer wants to merge 2 commits into
nf-core:devfrom
pontushojer:multiqc-docs

Conversation

@pontushojer

Copy link
Copy Markdown
Contributor

Relates to: #196

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

Copilot AI review requested due to automatic review settings July 29, 2026 11:36

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the pipeline output documentation to better describe custom sections that nf-core/seqinspector adds to MultiQC reports, addressing gaps noted in issue #196.

Changes:

  • Added documentation for the MultiQC subsampling notice section.
  • Added documentation (including a screenshot) for the in-report MultiQC reports index.
  • Added a corresponding entry to CHANGELOG.md.

Reviewed changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated 2 comments.

File Description
docs/output.md Adds new documentation for custom MultiQC sections (subsampling notice and report index).
CHANGELOG.md Records the documentation update under the dev “Added” section.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread docs/output.md Outdated
Comment thread docs/output.md Outdated
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.

2 participants