Skip to content

🔧 Dashboard Productize: Documentation and code quality #68

@lpgarzonr

Description

@lpgarzonr

Description

Create comprehensive documentation for the dashboard component and address code quality items, bringing it to the standard set by declarative-table-card and other shipped components.

Acceptance Criteria

Documentation

  • A docs/dashboard.md is created following the established format (see docs/declarative-table.md), containing:
    • Component description and purpose
    • Tag table (Angular <mfp-dashboard> / Web Component <mfp-wc-dashboard>)
    • Full property reference with types, defaults, and descriptions for config, sections, cards, availableCards
    • Full event reference with payload descriptions for saved
    • Model reference: DashboardConfig, CardConfig, SectionConfig interfaces with all fields documented
    • Usage example as a web component (HTML + JS)
    • Usage example as an Angular component (template + TypeScript)
  • The README.md component table is updated to include the dashboard

Code quality

  • No TODO, FIXME, or HACK comments left in the dashboard code
  • All public API types (CardConfig, SectionConfig, DashboardConfig) are documented describing each field, consider using JSDoc
  • Build succeeds: npm run build:ngx && npm run build:wc
  • Lint passes: npm run lint

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions