Skip to documentation
Optimal Learning Lab

Applying cognitive theory to optimize learning.
Menu

Where Custom Help Lives

Documentation homeView source on GitHub

# Custom Help Page Setup

Last Updated: 2026-09-04 | For: Administrators

The application can serve a site-specific in-app help page. The client checks for custom help first. When custom help is not set, the Help page uses the support destination from the published deployment Brand Profile; it does not silently substitute product-branded wiki content.

Where Custom Help Lives

  • Custom help markdown is stored in the active theme document (theme.help) in dynamic settings.
  • It is managed through admin controls in the Theme UI (custom help upload panel).
  • It is not a file on disk by default; it is stored in application data.

Who Can Edit It

  • Only users with admin role can set or remove custom help.
  • Server methods enforce this (setCustomHelpPage, removeCustomHelpPage).

How to Configure

  1. Sign in as an admin.
  2. Open the Theme/Admin controls page.
  3. Upload a .md file in the custom help section.
  4. Keep file size under 1 MB.
  5. Confirm the status banner shows custom help is active.

Runtime Behavior

  1. Help page calls getCustomHelpPage.
  2. If custom markdown exists and is enabled, it is rendered in-app at /help.
  3. If no custom help is configured, users see the configured Brand Profile support destination.

Offline Implications

  • With custom help configured, in-app help remains available without an external support site.
  • Without custom help, the deployment operator owns the availability of the configured support destination.

Operational Recommendation

Use a local custom help page for production deployments that may have restricted outbound internet access.

See Also