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-checkandapply.
Remaining weaknesses
- Some example pages still need richer expected-output snippets.
- Adapter extension docs are concise but could include a full mini implementation.
- We still need docs smoke tests beyond
mkdocs build(for link integrity and stale-language checks).
Improvement backlog
- Add link-check and stale-token lint in CI.
- Add one screenshot/GIF per top-level command (
onboard,doctor,run,demo). - Add one complete provider-adapter tutorial from zero to tests.
- Add docs style guide (voice, headings, command block conventions).
Review protocol per release
- Update reference pages first (CLI/config/schemas).
- Update task-driven guides (
quickstart,troubleshoot, provider setup). - Run
mkdocs buildand fix warnings. - Revisit this page and close or add backlog items.