Description
The usage documentation (docs/usage.md) currently mirrors the code structure rather than guiding users to their use case. A reorganisation to be more user-centric would improve the experience.
Current structure
- Pipeline parameters: see a different page
- Samplesheet input
- Multiple runs of the same sample
- Linting
- Strandedness prediction
- Errors and reporting
- Full samplesheet
- BAM input
- FASTQ sampling
- Adapter trimming
- Other pipeline steps...
Proposed structure
- How to run the pipeline (example)
- Samplesheet input
- Examples (simple, BAM input, etc.)
- Field definitions
- How to configure specific features (e.g. prokaryotic mode, UMIs, GPU)
- API-style organised reference docs
- Sequencing data quality assessment
- Sequencing data trimming
- Alignment to reference genome
- etc.
The goal is to guide users to their use case rather than presenting a wall of information.
Context
Raised by @adamrtalbot in the 3.23.0 release PR review.
Description
The usage documentation (
docs/usage.md) currently mirrors the code structure rather than guiding users to their use case. A reorganisation to be more user-centric would improve the experience.Current structure
Proposed structure
The goal is to guide users to their use case rather than presenting a wall of information.
Context
Raised by @adamrtalbot in the 3.23.0 release PR review.