Documentation Review

This page tracks documentation quality issues and continuous improvements.

What improved in this refactor

  • Rebuilt navigation around user jobs (Start Here, Use, Build, Operate, Architecture, Reference).
  • Reduced duplicate onboarding/configuration guidance.
  • Removed stale early-version framing from active docs.
  • Clarified deterministic troubleshooting with plan-check and apply.

Remaining weaknesses

  1. Some example pages still need richer expected-output snippets.
  2. Adapter extension docs are concise but could include a full mini implementation.
  3. We still need docs smoke tests beyond mkdocs build (for link integrity and stale-language checks).

Improvement backlog

  1. Add link-check and stale-token lint in CI.
  2. Add one screenshot/GIF per top-level command (onboard, doctor, run, demo).
  3. Add one complete provider-adapter tutorial from zero to tests.
  4. Add docs style guide (voice, headings, command block conventions).

Review protocol per release

  1. Update reference pages first (CLI/config/schemas).
  2. Update task-driven guides (quickstart, troubleshoot, provider setup).
  3. Run mkdocs build and fix warnings.
  4. Revisit this page and close or add backlog items.