-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
type:docsDocumentationDocumentation
Description
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
- CLI reference updated with
dev statsanddev dashboardcommands - New dashboard documentation page in website
- Architecture docs updated with stats aggregation
- README updated with dashboard mentions
- Screenshots/GIFs added showing dashboard in action
- Troubleshooting section for common issues
- API reference for dashboard routes (if public)
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 statssection - Add
dev dashboardsection - Examples with output
- Add
-
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.mdxapps/dashboard/README.md
Files to Modify:
README.mdARCHITECTURE.mdwebsite/content/docs/cli.mdxwebsite/content/docs/_meta.js(add dashboard page)
Metadata
Metadata
Assignees
Labels
type:docsDocumentationDocumentation