Problem
9 high-priority documentation gaps identified:
- CLI commands undocumented (17+ commands)
- No JSDoc on .tsx files
- No database schema docs
- No search architecture docs
- No developer onboarding guide
- LLM provider config undocumented
- No deployment guide
- Repository API undocumented
- VERSION/CHANGELOG sync broken
Solution
Phase 1: Critical Docs
docs/CLI.md — full command reference
docs/DATABASE.md — schema with ER diagram
docs/DEVELOPMENT.md — onboarding guide
Phase 2: Feature Docs
docs/SEARCH.md — search architecture
docs/LLM-SETUP.md — provider configuration
docs/REPOSITORY-API.md — API reference
Phase 3: Deployment
docs/DEPLOYMENT.md — hosting guide
- Fix VERSION/CHANGELOG sync
Phase 4: Code Docs
- JSDoc for all exported components
- JSDoc for Zod schemas
- JSDoc for error codes
Acceptance Criteria
Priority
High — 9 high-priority documentation gaps.
Plan
See plans/36-documentation-overhaul.md
Problem
9 high-priority documentation gaps identified:
Solution
Phase 1: Critical Docs
docs/CLI.md— full command referencedocs/DATABASE.md— schema with ER diagramdocs/DEVELOPMENT.md— onboarding guidePhase 2: Feature Docs
docs/SEARCH.md— search architecturedocs/LLM-SETUP.md— provider configurationdocs/REPOSITORY-API.md— API referencePhase 3: Deployment
docs/DEPLOYMENT.md— hosting guidePhase 4: Code Docs
Acceptance Criteria
Priority
High — 9 high-priority documentation gaps.
Plan
See
plans/36-documentation-overhaul.md