This project is intentionally small. Contributions should stay focused, documented, and token-based.
Workflow
- Add or update a component page in
src/pages/components/. - Add any required styles in
src/styles/global.css. - Add the route in
src/components/SidebarNav.tsx. - Ensure examples work in light and dark mode.
- Run build checks before merging.
Content standards
- Use sentence case headings.
- Keep copy warm, specific, and plain.
- No emoji.
- Include: usage snippet, variants, props table, accessibility notes.
Code standards
- Prefer design tokens over hard-coded colors/sizes.
- Reuse existing utility/demo classes where possible.
- Keep selectors component-scoped and readable.
Accessibility requirements
Each component doc must include:
- Keyboard expectations
- Screen reader label guidance
- Focus behavior
Pull request checklist
- Route added to sidebar
- Docs page added/updated
- Light + dark mode verified
- Keyboard behavior documented
- Build passes