Contextual help index
Maps stable helpKey strings (used by TenaBill console HelpIcon and HelpDrawer) to markdown articles under src/help/.
Convention: tb.{area}.{screen} — e.g. tb.settings.email-templates.
TenaBill console
| helpKey | Article | Console route |
|---|---|---|
tb.dashboard | tenabill/dashboard.md | / |
tb.catalog | tenabill/catalog.md | /catalog |
tb.customers | tenabill/customers.md | /customers |
tb.invoices | tenabill/invoices.md | /invoices |
tb.api-keys | tenabill/api-keys.md | /api-keys |
tb.webhooks | tenabill/webhooks.md | /webhooks |
tb.payments | tenabill/payments.md | /payments |
tb.finance | tenabill/finance.md | /finance |
tb.billing | tenabill/billing.md | /billing |
tb.usage | tenabill/usage.md | /billing/usage |
tb.settings | tenabill/settings.md | /settings |
tb.settings.branding | tenabill/branding.md | /settings/branding |
tb.settings.email-templates | tenabill/email-templates.md | /settings/email-templates |
tb.settings.marketing-content | tenabill/marketing-content.md | /settings/marketing-content |
tb.settings.usage-allowances | tenabill/usage-allowances.md | /settings/usage-allowances |
tb.settings.usage-allowances.plan | tenabill/usage-allowances-plans.md | /settings/usage-allowances/plans/:planCode |
tb.settings.usage-allowances.organization | tenabill/usage-allowances-organizations.md | /settings/usage-allowances/organizations/:organizationId |
Adding a new help article
- Create markdown under
src/help/tenabill/. - Add a row to the table above with a stable
helpKey. - Wire
<HelpIcon helpKey="..." />on the matching console page. - Register the path in
TenaBill.Web/src/helpKeys.ts(helpKeyPaths). - Add sidebar entry in
docs/.vitepress/config.tsif needed. - For spec-level detail, link to workspace-docs from the article footer.
Platform console help lives in tenancy-platform/docs/.