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.welcome | tenancyengine/welcome.md | TE Welcome (/welcome) |
| te.applications | tenancyengine/applications.md | TE Applications (/applications) |
| te.applications.settings | tenancyengine/applications-settings.md | Application → Settings |
| te.applications.environments | tenancyengine/applications-environments.md | Application → Environments |
| te.applications.payments | tenancyengine/applications-payments.md | Application → Payments |
| te.applications.features | tenancyengine/applications-features.md | Application → Features (contract tabs) |
| te.applications.offerings | tenancyengine/applications-offerings.md | Application → Offerings |
| te.applications.roles | tenancyengine/applications-roles.md | Application → Roles |
| te.applications.claims | tenancyengine/applications-claims.md | Application → Claims |
| te.organizations | tenancyengine/organizations.md | TE Organizations (/organizations) |
| te.tenants | tenancyengine/tenants.md | TE Tenants (/tenants) |
| te.tenants.entitlements | tenancyengine/tenants-entitlements.md | Tenants → Edit → Entitlements tab |
| te.users | tenancyengine/platform-staff.md | TE Users (/users) |
| te.audit | tenancyengine/audit.md | TE Audit log (/audit) |
| te.team | tenancyengine/team.md | TE Team (/team) |
| te.api-keys | tenancyengine/api-keys.md | TE API keys (/api-keys) |
| te.settings | tenancyengine/settings.md | TE Settings (/settings) |
| te.settings.security | tenancyengine/settings-security.md | TE Settings → Security (/settings/security) |
| te.billing | tenancyengine/billing.md | TE Billing (/billing) |
| te.platform.settings | tenancyengine/platform-settings.md | Platform settings → Overview |
| te.platform.features | tenancyengine/platform-features.md | Platform settings → Features |
| te.platform.offerings | tenancyengine/platform-offerings.md | Platform settings → Offerings |
| te.platform.roles | tenancyengine/platform-roles.md | Platform settings → Roles |
| te.platform.claims | tenancyengine/platform-claims.md | Platform settings → Claims |
| te.platform.plans | tenancyengine/platform-plans.md | TE Platform plans (/platform-plans) |
| te.platform.plan-marketing | tenancyengine/platform-plan-marketing.md | TE Plan marketing (/platform/plan-marketing) |
| 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
- Create markdown under
src/help/tenancyengine/. - Add a row to the table above with a stable
helpKey. - Wire
<HelpIcon helpKey="..." />on the matching consolePageHeaderorSectionCard. - Register the path in
TenancyEngine.Console/src/helpKeys.ts(helpKeyPaths). - Add sidebar entry in
docs/.vitepress/config.tsif needed. - 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.