Make your documentation visible to visitors

Updated May 22, 2026

Two switches, and they are not the same thing

This is where most confusion starts, so it is worth naming them once and sticking to it:

  • Which documentation set is on your public web address. A whole-set choice, made on Brand → Knowledge. A brand serves one at a time. This is never called publishing.
  • Publishing a category or a page. The per-item switch inside the set, deciding whether that one item shows up at all.

You need both. The web address belongs to your brand (see what a brand is in Yaplet).

Step 1 — put the set on your web address

  1. Go to Brand → Knowledge.
  2. Open the documentation set's three-dot menu.
  3. Choose Show at your-address.yaplet.help.

It is then served at https://your-address.yaplet.help/d/. Putting a second set up takes the first one down — nothing is deleted and nothing leaves your AI, it just stops being served. To take it offline, use Take down from the public site in the same menu. No chat widget is involved: a brand with no chat bubble anywhere still serves its documentation, and deleting the chat widget does not take the site down.

Step 2 — publish a category

Unpublished categories are invisible to visitors and to your AI. To publish one:

  1. Open your documentation set and click into the category.
  2. Turn on the Published switch in the category header.
  3. Or open Category Settings and turn it on there.

Unpublishing a category hides all its pages immediately — even pages that were individually published. Republishing the category brings every one of them straight back: their own Published switches were never touched, so a category is a blackout curtain, not an off switch. If you need a page to stay hidden afterwards, unpublish that page itself before you republish the category.

Step 3 — publish the pages

Each page has its own Published switch in the right-hand editor panel. A page only shows once its category is published too.

  • Select the page in the left tree.
  • Turn on Published in the editor panel header.
  • Save.

A published page is added to your AI's knowledge straight away — no chatbot and no chat widget needed. The same index powers the Ask AI box in your documentation site's search window, where visitors get an answer written from your published pages with links back to them. Unpublishing removes the page again, and editing re-indexes just that page.

Publishing many pages at once

When there is a lot to turn on, do not click through them one at a time:

  • From the category header: three-dot menu → Publish all pages. The category itself has to be published first.
  • From a parent page: three-dot menu on the page in the tree → Publish all children. You choose between direct children only and every nested page beneath it.

Bulk actions skip pages that are already in the state you asked for, so only genuinely new pages are indexed.

Check what your AI actually stored

Back on Brand → Knowledge, the Indexed column on the documentation set's row shows how many searchable pieces your AI has stored from it. A dash means nothing is stored yet. One page usually becomes several pieces, and — as the column's own tooltip says — only published items are stored. It is the honest answer to "is my documentation actually feeding the AI?"

Share a link to a page

Once a page is published, click Share in the editor. You get two kinds of link:

  • Direct link — readable, built from the category and page names, like /d/getting-started/installation. Good for search engines. Breaks if you rename the page or its category.
  • Fixed link — permanent, built from the page id, like /d/redirect?id=abc123. Never breaks. Use it for links inside your product or sent to customers.

Did this article answer your question?