Documentation sets

A documentation set is one documentation portal belonging to a brand. Categories hold pages, publishing a page makes it public and teaches the brand's AI, and one set at a time can sit on the brand's public web address.

Documentation sets

A documentation set is the top-level container holding a complete set of pages. Sets are rows on Brand → Knowledge, next to the brand's knowledge bases — there is no separate Documentation entry in the menu any more.

A brand can hold several documentation sets, and all of them feed the brand's AI. Only one at a time is served at the brand's public web address; the badge on each row shows which, as On public site or AI only.

Documentation is a paid module — $19 per month on top of your plan. It is not part of the access a new organization gets by default. Without it, the Documentation card in the Add knowledge window is grayed out behind a padlock and reads "Available on a higher plan." instead of opening.

Creating, deleting and sharing between brands

Press Add knowledge on the Knowledge screen and choose Documentation (in the part called Help content customers can read too). It is created with the default name Documentation and drops you straight into its editor.

Delete one from the row's ⋯ menu. The confirmation names what dies ("12 pages and their categories"), says your AI stops answering from that content immediately, and adds a second paragraph if this is the set currently on your public address — that address will show nothing until you put another one there. It cannot be undone.

The same menu offers Copy to another brand… and Move to another brand…. Both are grayed out while your account has only one brand.

Documentation Settings

Unlike a knowledge base, a documentation set's editor has no Settings button, and nothing in the dashboard links to the set's settings page. Its Language can be changed right on the set's row on Brand → Knowledge, in the language drop-down. The full settings page opens at /dashboard/documentation/<set id>/settings — open the set's editor and add /settings to the end of its web address. The page has a General section with Save changes and Discard buttons that appear once you change something (leaving with unsaved edits asks you first):

  • Title — the name of the documentation set, shown at the top of the public documentation and in the dashboard
  • Language — the language your pages are written in. It decides how your AI searches the text, and it translates nothing. Changing it applies to content indexed from then on; pages already stored keep the setting they were indexed with until you publish them again.

Below it, a Where it's used section lists the widgets that show this documentation, each as a button that opens that widget. Nothing is attached or detached from here; the Manage on the brand's Knowledge page button takes you to the screen that does that. With no widget it says No widget shows this documentation yet.

The logo is no longer set per documentation set. It comes from the brand: Brand settings → General → Logo → Brand logo. That is one main image plus an optional second version tied to either light or dark mode. The documentation set's own settings page has a Branding section with the notice The logo lives on the brand now and an Open Brand settings button.
While a set is not on any brand's public address, its settings page shows "Not publicly available — this documentation is not on any brand's public address, so visitors cannot browse it." Put it on the address from the brand's Knowledge screen, using Show at followed by your address (for example Show at acme.yaplet.help) in the row's ⋯ menu.

Categories

Categories organize documentation pages into logical groups within a documentation set. They provide navigation structure and help users find relevant information quickly.

Category Settings

Open a category's settings with the cog icon at the end of its row in the set's category list. Categories have simple settings:

  • Name - The display name of the category
  • Description - A brief description for category listings
  • Visibility - Draft or Published. A draft is only seen by your team: visitors can't open it and the AI doesn't answer from it. A published category can be read on your documentation site, and the AI answers from its published pages.

Category Management

Categories are ordered by their Order value, which determines their display sequence. Use the up and down arrow icons at the end of a row to reorder categories as needed. A category row also has icons for Settings, Share Category URL and Delete Category. The list can be filtered by name, description and published state (All categories, Published, Not Published); the Created At column is hidden at first and can be switched on from the table's Columns menu.

Categories with a lower order number appear first. Plan your category order to match user expectations.

Publishing & Visibility

Documentation content can be published or unpublished at both the category and page level, giving you fine-grained control over what content is publicly accessible and available in AI knowledge.

Category Publishing

Categories can be published or unpublished with the Published button in the category list, (it asks you to confirm), or with Visibility on their settings page. When a category is unpublished:

  • All pages within the category are removed from AI knowledge
  • The category disappears from public documentation navigation, and visitors can't open it
  • The pages' own publish switches are left as they were: a page that was published stays marked published, it just isn't shown or learned while its category is a draft
Unpublishing a category hides its pages from visitors and removes them from AI knowledge, but it does not change the pages' own published state. When you republish the category, the pages that were published come back and are added to AI knowledge again (it may take a moment).

Page Publishing

Individual pages can be published or unpublished independently, with these effects:

  • Published pages: Available in public documentation and processed for AI knowledge
  • Unpublished pages: Hidden from public view and excluded from AI processing
  • Parent page dependency: A page cannot be published if its parent page is unpublished
Use the status indicators (green dots for published, red dots for draft, yellow dots for published with unpublished children) in the hierarchy tree and category header to quickly see the publish state of your content.

Bulk Publishing

When working with large documentation trees, you can publish or unpublish multiple pages at once:

  • From a parent page's menu: Use "Publish all children" or "Unpublish all children" in the three-dot context menu of any page that has child pages. The "Publish all children" option is only available when the parent page itself is already published.
  • From the category header: Click the three-dot menu next to the category name to access "Publish all pages" or "Unpublish all pages" for all pages in the category. "Publish all pages" requires the category to be published first.
  • When publishing a parent: After you publish a page that has unpublished children, you'll be prompted to optionally publish the children as well.

When any of the target pages have their own nested children, you'll be asked to choose between publishing direct children only or all nested children (including grandchildren and deeper levels).

Bulk publish only affects pages that are currently unpublished (and vice versa for bulk unpublish). Pages already in the target state are skipped. Only newly changed pages are processed for AI knowledge, keeping the operation efficient.

AI Knowledge Integration

Only published pages in published categories are processed for AI knowledge, and what they feed is the brand's knowledge — the same pool the brand's chat, phone calls, inbox reply suggestions and AI social posts all read from:

  • Publishing content adds it to the brand's knowledge straight away (it may take a moment to process). No chat widget and no AI agent have to exist for that to happen.
  • Unpublishing content immediately removes it from the brand's knowledge.
  • A page you publish while its category is still a draft is marked published, but it is neither shown nor taught to the AI until the category is published.
Each published page becomes one or more searchable pieces, counted on the documentation set's row on the brand's Knowledge screen (for example 12 pieces indexed). Whether Yaplet learns new pages depends on whether someone can pay for it — your free 14 days, bought credit or a paid plan; see How much Yaplet can learn. Without a paid plan, the last 500 credits are kept for answers: below that line a page you publish still goes live, but the payment window opens and Yaplet keeps the version of the page it already knew. Only some older free workspaces keep a limit of 250 searchable pieces, shared across every brand, every knowledge base and every documentation set.

Public Documentation Behavior

Published content follows these rules in public documentation:

  • Only published categories appear in the navigation bar
  • Only published pages are accessible via public links
  • Unpublished content is completely hidden from external users
  • Share links for unpublished content will not work

Public Documentation Navigation

When a documentation set is served at a brand's web address, categories appear as a navigation bar below the header when there are multiple categories.

Categories are displayed as a navigation bar below the header when there are multiple categories in a documentation set.

For more details about the public documentation interface, see our public documentation guide.

When a documentation set contains only one category, the navigation bar is hidden for a cleaner reading experience.

Changes to category names or structure can break existing share links. Consider the impact before making significant changes.

© 2026 Yaplet. All rights reserved.