Skip to content

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

helpKeyArticleConsole route
tb.dashboardtenabill/dashboard.md/
tb.catalogtenabill/catalog.md/catalog
tb.customerstenabill/customers.md/customers
tb.invoicestenabill/invoices.md/invoices
tb.api-keystenabill/api-keys.md/api-keys
tb.webhookstenabill/webhooks.md/webhooks
tb.paymentstenabill/payments.md/payments
tb.financetenabill/finance.md/finance
tb.billingtenabill/billing.md/billing
tb.usagetenabill/usage.md/billing/usage
tb.settingstenabill/settings.md/settings
tb.settings.brandingtenabill/branding.md/settings/branding
tb.settings.email-templatestenabill/email-templates.md/settings/email-templates
tb.settings.marketing-contenttenabill/marketing-content.md/settings/marketing-content
tb.settings.usage-allowancestenabill/usage-allowances.md/settings/usage-allowances
tb.settings.usage-allowances.plantenabill/usage-allowances-plans.md/settings/usage-allowances/plans/:planCode
tb.settings.usage-allowances.organizationtenabill/usage-allowances-organizations.md/settings/usage-allowances/organizations/:organizationId

Adding a new help article

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

Platform console help lives in tenancy-platform/docs/.

TenaBill billing documentation