-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
docsRelated to documentationRelated to documentationepicParent issue tracking multiple related issuesParent issue tracking multiple related issues
Description
Overview
Documentation needs a quality pass now that features have stabilized. This epic covers making docs comprehensive, accurate, and easy to navigate.
Goals
- All features are documented with examples
- Onboarding guides get users productive in minutes
- API reference is complete and auto-generated where possible
- Cookbook recipes cover common real-world scenarios
Sub-Issues
Quality Pass
- Audit all docs pages for accuracy against current CLI
- Remove or update any references to old command syntax
- Version numbers kept current (automated where possible)
- Consistent formatting and style across all pages
Onboarding
- Quick start guide per persona (Cloud user, Enterprise admin, MCP/AI user)
- First 5 minutes experience optimization
- Video / GIF demos for key workflows
Reference
- Complete command reference (auto-generated from clap)
- MCP tool reference (auto-generated from schemas)
- Configuration file reference
- Environment variable reference
Cookbook
- Common Cloud workflows (provision, scale, monitor)
- Common Enterprise workflows (health check, upgrade prep, support package)
- MCP integration recipes (Claude, Cursor, custom agents)
- CI/CD integration examples
Infrastructure
- Doc site build in CI (catch broken links, formatting)
- Doc versioning strategy (match CLI releases)
Key Paths
- Doc source:
docs/docs/ - Doc config:
docs/mkdocs.yml - README:
README.md
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
docsRelated to documentationRelated to documentationepicParent issue tracking multiple related issuesParent issue tracking multiple related issues