You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
Description
Create comprehensive documentation for the dashboard component and address code quality items, bringing it to the standard set by
declarative-table-cardand other shipped components.Acceptance Criteria
Documentation
docs/dashboard.mdis created following the established format (seedocs/declarative-table.md), containing:<mfp-dashboard>/ Web Component<mfp-wc-dashboard>)config,sections,cards,availableCardssavedDashboardConfig,CardConfig,SectionConfiginterfaces with all fields documentedREADME.mdcomponent table is updated to include the dashboardCode quality
TODO,FIXME, orHACKcomments left in the dashboard codeCardConfig,SectionConfig,DashboardConfig) are documented describing each field, consider using JSDocnpm run build:ngx && npm run build:wcnpm run lint