Skip to content

[Epic 6] Documentation & Polish #6

@smagala

Description

@smagala

Description

Complete documentation and finalize code quality.

Stories

  • 6.1 Write usage documentation (45 min)
  • 6.2 Write output documentation (45 min)
  • 6.3 Create nextflow_schema.json (30 min)
  • 6.4 Update CITATIONS.md (20 min)
  • 6.5 Add MultiQC integration (45 min)
  • 6.6 Run nf-core lint (30 min)
  • 6.7 Create CHANGELOG.md (15 min)

Acceptance Criteria

  • docs/usage.md documents all parameters with examples
  • docs/output.md describes all output files
  • nextflow_schema.json enables nf-core launch
  • CITATIONS.md includes all tool citations (bwa, samtools, ivar, etc.)
  • MultiQC custom content displays denver-specific results
  • nf-core lint passes with no warnings
  • CHANGELOG.md documents v1.0.0 features

Estimated LoE

3.75 hours

Dependencies

Epics 1-5 complete

Metadata

Metadata

Assignees

No one assigned

    Labels

    P1High prioritydocumentationImprovements or additions to documentationepicEpic-level tracking issue

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions