Branch: docs/dashboard-updates
Priority: Medium
Parent Epic: #145
Type: Task
Description
Update all relevant documentation to cover the new dashboard features. This includes CLI reference, web dashboard usage, API documentation, and architecture docs.
Acceptance Criteria
Technical Requirements
Documentation Pages to Create/Update:
-
Website: Dashboard Guide (website/content/docs/dashboard.mdx)
- Overview of dashboard features
- Installation and setup
- Using the CLI version
- Using the web version
- Screenshots
- Troubleshooting
-
Website: CLI Reference (website/content/docs/cli.mdx)
- Add
dev stats section
- Add
dev dashboard section
- Examples with output
-
Architecture Docs (ARCHITECTURE.md)
- Add section on stats aggregation
- Data flow diagrams
- Performance considerations
-
Dashboard README (apps/dashboard/README.md)
- Setup instructions
- Development guide
- API documentation
- Component overview
-
Main README (README.md)
- Add dashboard to feature list
- Link to dashboard docs
- Add screenshot
Screenshots Needed:
- CLI rich output (terminal screenshot)
- Web dashboard overview
- Language distribution chart
- Component type chart
Files to Create:
website/content/docs/dashboard.mdx
apps/dashboard/README.md
Files to Modify:
README.md
ARCHITECTURE.md
website/content/docs/cli.mdx
website/content/docs/_meta.js (add dashboard page)
Branch:
docs/dashboard-updatesPriority: Medium
Parent Epic: #145
Type: Task
Description
Update all relevant documentation to cover the new dashboard features. This includes CLI reference, web dashboard usage, API documentation, and architecture docs.
Acceptance Criteria
dev statsanddev dashboardcommandsTechnical Requirements
Documentation Pages to Create/Update:
Website: Dashboard Guide (
website/content/docs/dashboard.mdx)Website: CLI Reference (
website/content/docs/cli.mdx)dev statssectiondev dashboardsectionArchitecture Docs (
ARCHITECTURE.md)Dashboard README (
apps/dashboard/README.md)Main README (
README.md)Screenshots Needed:
Files to Create:
website/content/docs/dashboard.mdxapps/dashboard/README.mdFiles to Modify:
README.mdARCHITECTURE.mdwebsite/content/docs/cli.mdxwebsite/content/docs/_meta.js(add dashboard page)