Skip to content

📚 UI Documentation Index

This index provides a central reference for all UI-related documentation, guidelines, and workflow rules for InsightHub Frontend.


🔗 Key UI Documentation

🎨 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

  1. Update or Create Documentation:
  2. For every new or changed UI component, update COMPONENT_GUIDELINES.md or create a new doc in docs/frontend/.
  3. Include: props, usage examples, accessibility notes, and design system integration.

  4. Link Documentation to Task:

  5. Add a reference to the documentation in the relevant Taskmaster task (in details, comments, or a docs field).

  6. Add to This Index:

  7. Ensure your new/updated documentation is listed here for discoverability.

📝 Additional UI Docs & Rules


Always keep this index up to date when adding or changing UI documentation!