nf-core / nf-core/seqinspector
update docs for Multiqc output
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Nextflow
- Stars
- 28
- Forks
- 44
- Avg merge
- 11d 8h
- Merged PRs (30d)
- 2
Description
Description of feature
There is currently no detailed description of the Multiqc output that includes figures, or explainers. Some features (like the report index) are missing in the docs.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing documentation for MultiQC output and the generated report, focusing on figures, explainers, and the report index. Done means the docs describe these output features in sufficient detail, including the currently missing report index.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100