Skip to content

Task: Update Documentation for Dashboard Features #150

@prosdev

Description

@prosdev

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 stats and dev dashboard commands
  • 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:

  1. 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
  2. Website: CLI Reference (website/content/docs/cli.mdx)

    • Add dev stats section
    • Add dev dashboard section
    • Examples with output
  3. Architecture Docs (ARCHITECTURE.md)

    • Add section on stats aggregation
    • Data flow diagrams
    • Performance considerations
  4. Dashboard README (apps/dashboard/README.md)

    • Setup instructions
    • Development guide
    • API documentation
    • Component overview
  5. 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)

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions