docs/README.md

Docs

The standing rules for how this repo is built live in /CLAUDE.md.

Current

  • BUILD-PLAN.md — the canonical phased build plan (architecture, Radix Themes-first hybrid, tokens & theming, Portal Design Studio)
  • NAMING.md — token and component naming conventions (the formula, anatomy names, file rules)
  • changelog.md — version history
  • component-index.md — index of components and their build status

Generated / planned

These are produced from the manifest (or authored) as their phase lands — see BUILD-PLAN.md.

  • TOKENS.md — human-readable token reference (Phase 1, generated)
  • COMPONENTS.md — component catalogue index (Phase 3, generated)
  • SCREENS.md — screen & flow registry (Phase 4)
  • MODULES.md — white-label module inventory + versions (Phase 5)
  • CHANGELOG.md — release changelog for published versions (currently changelog.md)
  • DEPLOYMENT.md — deploy pipeline + required secrets (Phase 6, dev-owned)