Set up your help center

Turn on the Help Center module, set the homepage title and description, add header links, and control visibility, domains, languages and indexing.

JM
James Morton
Written By James MortonLast updated 1 day ago

This article walks workspace admins through turning on the help center, setting its homepage, and checking that it's live.

1. Turn on the module

The help center is off by default for new workspaces.

  1. Go to Admin > Settings > General.
  2. Under Modules, turn on Help Center.

A Help Center item appears in the admin sidebar, and Help Center appears under Modules in Settings.

Note: Once the module is on, the help center is public at /hc on your workspace's address. Visitors only see published articles in public categories, so nothing you draft is visible until you publish it.

2. Set the homepage

Go to Admin > Settings > Help Center, on the General tab.

Setting

Default

What it does

Title

"How can we help?"

The heading above the search box

Description

"Search our knowledge base or browse by category"

The line under the heading

Keep the title short and the description action-oriented. Changes save automatically.

Under Header links, add up to 3 links that appear beside the navigation on help center pages, for example to your main website or status page. Each link has a label and a URL (a full https:// address or a path such as /roadmap).

4. Control who can see what

There is no single on/off switch for visibility. You control it per category and per article:

  • A category's Public toggle hides or shows it (and its articles) on the public help center.
  • A public category can be restricted to selected segments of signed-in users.
  • Each article has an Audience: Everyone, or selected segments.

See Organize with categories and Write and publish articles.

5. Domains, languages and indexing

The Domains & languages tab holds the rest of the configuration:

  • Custom domain (self-hosted): serve the help center from its own hostname. On Cloud, use Admin > Settings > Domains. See Use a custom domain.
  • Redirect rules: send an old /hc path to a published article or category, useful after moving from another help center.
  • Indexing: turn search engine indexing off to add a noindex tag to every /hc page and remove the help center from the sitemap and robots.txt.
  • Languages and Auto-translate: publish articles in more than one language. See Write and publish articles.

6. Check that it works

Open /hc on your workspace's address. You should see your homepage text and your public categories. If the page doesn't load, confirm the Help Center module is on in Admin > Settings > General.

Was this helpful?

Your feedback shapes what we write next.