Docs
Sign in

Public knowledge base

Publish pages to your organization’s public help centre, and see exactly what visitors without a UnitX account can read.

Your organization has a public help centre that anyone on the internet can read without signing in. It lists every page you have marked External and Published, so customers, partners and prospects can find answers without a UnitX account. You publish to it from the page editor; there is nothing separate to set up.

How it works#

The help centre lives at /kb/<organization-slug> on your UnitX address, where the organization slug is your organization’s short name (for Everyrealm, /kb/everyrealm). Each article has its own address, /kb/<organization-slug>/<page-slug>.

A page appears in the help centre only when both of these are true:

  • its Visibility is external, and
  • its status is Published.

Drafts, pages in review, archived pages and deleted pages never appear, even if someone guesses their address. A page that isn’t published answers exactly as if it didn’t exist.

Who can publish#

Permissions

document.edit
Publishing to the help centre uses two access levels on the page itself. Setting a page’s visibility to external needs Owner access to that page, and publishing it needs Publisher access. Both come from a share on the page or from being an organization administrator. See Who can open a page.

Publish an article#

  1. Write the page

    Create the page in Documents. The page’s address in the help centre is made from the title it had when it was created, so pick a clear title from the start. Renaming the page later doesn’t change its address.
  2. Make it an article (recommended)

    In the Knowledge base section at the bottom of the page, add a Summary (optional) and Category (optional) and click Make this an article. The summary and category are shown under the title in the help centre list. Then click Submit for review.
  3. Set the visibility to external

    In the Visibility menu next to the title, choose external.
  4. Publish it

    Click Publish. The page appears in the help centre straight away.

Articles are reviewed first

A page you have made into a knowledge article can only be published after it has been submitted for review. An ordinary page can be published straight from Draft. See knowledge articles.

What visitors see#

The article list#

The help centre opens with a Help centre heading, a Search articles… box and the list of published articles, most recently updated first. Each entry shows the article title, and its summary and category if it has them. Search matches article titles.

If nothing is published yet, visitors see Nothing published yet. If the address doesn’t match an organization, they see There is no help centre at this address.

An article#

An article shows an All articles link back to the list, the page icon and title, the date it was last updated, and its content. Headings, lists, checklists (with their ticks), quotes, code (with its language), callouts in their colours, tables and dividers are all shown. The footer reads Published with UnitX. An address that no longer points at a published article shows This article is not available.

Some blocks aren’t shown publicly

Images, file blocks and embeds don’t appear on the public page. Comments, version history, related work and attached files are never shown. Search engines may index help centre articles, and visitors can copy their text.

Update or remove an article#

  • Update it: edit the page as usual. Visitors see the current content the next time they load the article.
  • Take it down: click Unpublish, change the visibility away from external, or archive the page. Any of these removes it from the help centre immediately.
Help centreShare link
Who can read itEveryoneWhoever has the link
Which pagesEvery page that is External and PublishedOne page, any status
Listed and searchableYesNo
Password and expiryNoOptional
Search engine indexing, copying, brandingAlways allowed and shownYour choice, per link

The two are independent: setting one has no effect on the other. To send one page to one client, use a share link.

FAQ#

I published a page but it isn’t in the help centre.
Check that its visibility is external. Pages with any other visibility stay inside UnitX even when published.
Can visitors leave feedback or comments?
No. The help centre is read-only. Colleagues inside UnitX can rate an article with Yes or No on the page itself.
Does the help centre use our branding?
Articles carry a “Published with UnitX” footer. There are no per-organization theme settings for the help centre.
Where do I find our organization slug?
It is the short name chosen for your organization when it was created. If you aren’t sure of it, ask an administrator.

Still stuck? Search the docs with ⌘K, open Help inside UnitX, or contact support.