Files
community-rule/docs/README.md
T
2026-05-21 22:56:34 -06:00

2.2 KiB

Documentation

User-facing docs. Implementation conventions live in .cursor/rules/.

Canonical references

  • create-flow.md — Custom create-rule wizard: stages, URLs, persistence. Source of truth for product/eng alignment.
  • testing-guide.md — Testing philosophy, layer coverage, and Prisma migration smoke before merge.
  • figma-component-registry.md — Figma Community Rule System file ↔ app/components/ (and route-colocated admin UI) map.

Author guides (guides/)

Temporary backend planning

These will be deleted once the backend services are stood up:

Cursor rules

Implementation contracts are enforced by .cursor/rules/*.mdc:

Rule Scope
component-structure.mdc 4-file split (container/view/types/index).
component-props.mdc Lowercase enum prop convention + Figma traceability.
tailwind-styling.mdc Token usage and class composition.
localization.mdc messages/ bundles and useMessages().
testing.mdc Test layout, helpers, required imports.
storybook.mdc Story location and argTypes patterns.
hooks.mdc Custom hook authoring + TSDoc as the API reference.
create-flow.mdc Wizard step / screen registry conventions.
api-routes.mdc API route handler conventions.