Skip to content

docs: documentation consistency report — 10 inconsistencies found #41

@nextlevelshit

Description

@nextlevelshit

Documentation Consistency Report

Scan date: 2026-02-09T14:55:00Z
Revalidated: 2026-02-11
Remaining inconsistencies: 3 (7 fixed)

Remaining Items

  • [DOC-004] (MEDIUM) README says 18 built-in pipelines but 19 exist — README.md:288,300
    Fix: Update '18 built-in pipelines' to '19 built-in pipelines' in README.md.

  • [DOC-006] (MEDIUM) GitHub adapter exists in code but not documented in adapters reference — docs/reference/adapters.md
    Fix: Add a GitHub adapter section to docs/reference/adapters.md documenting the GitHubAdapter, its purpose (GitHub API operations), required environment variables (GH_TOKEN/GITHUB_TOKEN), and how it differs from the LLM CLI adapters.

  • [DOC-007] (MEDIUM) GITHUB_TOKEN env var used in code but not documented in environment reference — docs/reference/environment.md
    Fix: Add GITHUB_TOKEN/GH_TOKEN to the required environment variables section in docs/reference/environment.md, documenting it as required for the GitHub adapter and github-related personas/pipelines. Currently only appears as an example in the audit redaction patterns table.

Fixed Items (verified 2026-02-11)

  • [DOC-009] (CRITICAL) Pipelines speckit-flow-test and speckit-impl-test not in internal/defaults — test pipelines removed, no longer relevant
  • [DOC-001] (HIGH) README Available Commands block missing meta and migrate — both commands now listed
  • [DOC-002] (HIGH) CLI docs use --status but code defines --run-status — docs correctly say --run-status
  • [DOC-003] (HIGH) CLI docs show resume with positional arg but code uses --pipeline flag — docs match implementation
  • [DOC-005] (MEDIUM) wave run --force flag undocumented in CLI reference — now documented
  • [DOC-008] (MEDIUM) NO_UNICODE env var used in code but undocumented — now documented
  • [DOC-010] (LOW) CLI docs show --pipeline flag for wave run Options but it's redundant — complete flag table exists

Generated by Wave doc-loop pipeline, revalidated manually

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions