Skip to content

Contextual help index

Maps stable helpKey strings (used by VectraLabel app HelpIcon and HelpDrawer) to markdown articles under src/help/.

Convention: vl.{area}.{screen} — e.g. vl.labels.

VectraLabel app

helpKeyArticleApp route
vl.labelsvectralabel/labels.md/app (label list)
vl.compliancevectralabel/compliance.mdlabel detail / validate
vl.templatesvectralabel/templates.md/app (templates)
vl.billingvectralabel/billing.mdbilling / usage

Adding a new help article

  1. Create markdown under src/help/vectralabel/.
  2. Add a row to the table above with a stable helpKey.
  3. Wire <HelpIcon helpKey="..." /> on the matching app page when the React UI is added.
  4. Register the path in the app's helpKeys.ts (helpKeyPaths).
  5. Add sidebar entry in docs/.vitepress/config.ts if needed.

Platform console help lives in tenancy-platform/docs/. TenaBill merchant console help lives in tenabill/docs/.

VectraLabel documentation