Skip to content

Contextual help index

Maps stable helpKey strings (used by console HelpIcon and future AI drawer) to markdown articles under src/help/.

Convention: {product}.{area}.{screen} — e.g. te.platform.email-templates, tb.settings.branding.

TenancyEngine console

| helpKey | Article | Console route |

|---------|---------|---------------|

| te.dashboard | tenancyengine/dashboard.md | TE Overview (/) |

| te.applications | tenancyengine/applications.md | TE Applications (/applications) |

| te.applications.settings | tenancyengine/applications-settings.md | Application → Settings |

| te.applications.payments | tenancyengine/applications-payments.md | Application → Payments |

| te.applications.features | tenancyengine/applications-features.md | Application → Features (contract tabs) |

| te.organizations | tenancyengine/organizations.md | TE Organizations (/organizations) |

| te.tenants | tenancyengine/tenants.md | TE Tenants (/tenants) |

| te.users | tenancyengine/platform-staff.md | TE Users (/users) |

| te.billing | tenancyengine/billing.md | TE Billing (/billing) |

| te.platform.email-templates | tenancyengine/platform-email-templates.md | TE Platform settings → Email templates (/platform/email-templates) |

| te.platform.content | tenancyengine/platform-content.md | TE Platform settings → Content (/platform/content) |

Adding a new help article

  1. Create markdown under src/help/tenancyengine/.
  2. Add a row to the table above with a stable helpKey.
  3. Wire <HelpIcon helpKey="..." /> on the matching console PageHeader or SectionCard.
  4. Register the path in TenancyEngine.Console/src/helpKeys.ts (helpKeyPaths).
  5. Add sidebar entry in docs/.vitepress/config.ts if needed.
  6. For spec-level detail, link to workspace-docs (D:\repos\docs\) from the article footer.

TenaBill console help lives in tenabill/docs/.

See operating model §7 in AUTONOMOUS-AGENT-OPERATING-MODEL.md.

TenancyEngine platform documentation