Skip to content

Help Center (TenancyEngine)

Publish a categorized, searchable public support site for your application's own end users — the same shape as a typical vendor help site: category tree → articles, live search, one destination URL. You author it yourself from TE Console; there's no code deploy per article and no engineer involved.

Console: Application workspace → Help Center (/applications/:id/help-center)

Requires Applications configure to create, edit, publish, or delete categories and articles. Read-only access shows existing content.

Requires the Growth plan or higher (platform.help_center.enabled). On a lower-tier plan, write actions return a help_center_not_included error explaining the upgrade requirement — reading existing configuration is unaffected.

How it works

Content is organized as categories (e.g. "Getting Started," "Billing," "Troubleshooting") containing articles. Article bodies are built from the same block-based editor used by the application's Content pages (rich text, images, stat rows, FAQ accordions, and more) — so authoring feels identical whether you're editing a marketing page or a help article.

Each article has a Draft/Published status. Only published articles appear on the public site and in search results.

Adding a category

  1. Open the Help Center panel and click Add category.
  2. Enter a slug (used in the public URL) and a title.
  3. Click Create.

Rename a category or reorder it relative to others at any time — renaming doesn't change its slug or break existing article links.

Adding an article

  1. Expand a category and click Add article.
  2. Enter a slug and title.
  3. Use the block editor to build the article body, then set Status to Published when it's ready for end users.

Public site

Once published, the Help Center is served at the application's Support custom domain (or the platform-assigned fallback host for apps without one):

  • /site/help — category index with live search
  • /site/help/{categorySlug}/{articleSlug} — one article
  • /site/help/search?q= — search results (Postgres full-text search, ranked by relevance)

Deleting a category

A category must be empty before it can be deleted — move or delete its articles first. This is a deliberate guard against accidentally losing published content.

  • Custom domains — configure the Support domain the Help Center is served on

TenancyEngine platform documentation