Skip to content

Feature: <Name>

Copy this file to features/<name>.md, fill every section, and add a sidebar entry in .vitepress/config.mjs. Keep it link-rich — point at real files with their paths.

Summary

One paragraph: what the feature does and who uses it (tier + persona).

Location

  • Tier / path: src/tiers/<tier>/features/<name>/
  • Route(s): link to entries in the Route Map.
  • Entry page: pages/<Name>Page.jsx

Data flow

LayerFile(s)
Pagespages/…
Componentscomponents/…
Hooks (reads)hooks/use….js → RPC get_…
Services (writes)services/…Service.js → EF
Utilsutils/…

Edge functions

List the EFs this feature calls, linking to the EF index.

Database

Tables this feature reads/writes, linking to the table index.

End-to-end trace

UI component → route → hook/service → RPC/EF → table. Spell out one concrete path so a new dev can follow it.

Tests

Where the tests/ folder is and the per-feature script (e.g. npm run test:<name>).

Gotchas

Non-obvious constraints, invariants, or known issues.