📚 UI Documentation Index
This index provides a central reference for all UI-related documentation, guidelines, and workflow rules for InsightHub Frontend.
🔗 Key UI Documentation
- Component Guidelines — Standards for building, testing, and documenting UI components
- UI Development Workflow — End-to-end UI workflow, including documentation requirements
- Frontend Quality Assurance — QA gates, testing, and accessibility
- QA Processes — Full QA process, including UI testing
🎨 Design System & Patterns
- Design Tokens: Use TailwindCSS tokens and custom design system classes (see
tailwind.config.js) - Typography, Colors, Spacing: Follow patterns in Component Guidelines
🧑💻 How to Document UI Components
- Update or Create Documentation:
- For every new or changed UI component, update
COMPONENT_GUIDELINES.mdor create a new doc indocs/frontend/. -
Include: props, usage examples, accessibility notes, and design system integration.
-
Link Documentation to Task:
-
Add a reference to the documentation in the relevant Taskmaster task (in
details,comments, or adocsfield). -
Add to This Index:
- Ensure your new/updated documentation is listed here for discoverability.
📝 Additional UI Docs & Rules
- Svelte Component Patterns
- UI Testing Standards
- Performance UI Rules
- Accessibility UI Rules
- Tailwind Design UI
Always keep this index up to date when adding or changing UI documentation!