Page Doc Template

Copy this template for every route and subpage doc under docs/routes/**.

---

Route

• Path: /...
• Parent: ../README.md
• Children: (links, if any)

---

Purpose (business goal)

TBD

---

User roles & permissions

• Roles: TBD
• Permissions: TBD
• Reference: Roles & Permissions Model

---

Layout structure

Describe major regions (header/nav/primary content/side panels/modals).

---

Components used

List reusable components and link to their docs in docs/components/**.

---

States

• Empty: TBD
• Loading: TBD
• Error: TBD
• Complete: TBD

---

Business logic (high-level)

Describe orchestration at a high level and link to domain docs for canonical rules.

• Domain refs: docs/domains/...

---

API dependencies

• Endpoints: TBD
• Auth: TBD
• Rate limits: TBD
• Webhooks/events: TBD

---

Workflow dependencies

Describe any cross-route, cross-entity, or cross-system flow this page participates in.

• Workflow refs: docs/workflows/...

---

Prompt / AI behavior dependencies (if applicable)

Document any AI prompt, instruction, or LLM behavior contract that materially affects this page.

• Prompt refs: docs/prompts/...
• AI governance refs: docs/ai-governance/...

---

Enterprise constraints

• Multi-brand considerations
• Multi-workspace isolation
• Audit / data retention
• Localization / time zones

---

Edge cases

TBD

---

Security & compliance considerations

• Data access boundaries
• PII handling
• Permission checks
• Audit logging

Reference: Security & Compliance

---

Analytics events (if applicable)

• Event names and payload contracts
• Success/failure tracking

Reference: Analytics Events (MVP)