Knowledge Base
Your public knowledge base is a customer-facing library of published articles, served on your brand's own web address, with categories, search, languages and ratings.
Overview
The knowledge base is the public page where customers read the articles you have published. It is served on your brand's own web address, under /k, and it works whether or not the brand has a chat widget.
Your brand's address
Served at <your-brand-address>.yaplet.help/k. The address belongs to the brand.
Full-text search
Visitors search article titles and article text, with the matching words highlighted.
Multi-language
Serve articles in several languages, with a switcher in the header.
Article ratings
Visitors tell you whether an article answered their question.
The web address
Your knowledge base is served at:
https://<your-brand-address>.yaplet.help/k
A brand can have a web address of the form <name>.yaplet.help, and you set it at Brand → Brand settings → Public address. A brand that has not been given one yet shows a No address badge on the Public help site card at the top of its Knowledge screen — This brand has no web address yet. — with a Set an address button through to Brand settings.
/s offline, because both the roadmap board and the page styling come from the widget. Read Chat widget before you delete one.<name>.yaplet.help stops working and the new one starts. Links people have already saved — in emails, in search results, on your own site — break, and the old address is released, so another organization can claim it. That is why the change asks you to confirm it, and why it cannot simply be undone. Links that the AI writes into its own answers do not break: those are built from the address the brand has at the moment it answers.Choosing which knowledge base is served
Everything the brand's AI can read is listed on Brand → Knowledge, in groups. Only the Knowledge bases & documentation group — the brand's knowledge bases and documentation sets — marks each row On public site or AI only; the Public help site card above it shows the address and whether something is Live on it. Everything in the other groups (Website, Files, Text snippets, Questions & answers and API tools) feeds the AI only; it never goes to a public address, so it carries no such mark.
- A row that is AI only has Show at
<address>in its ⋯ menu (Show at your web address while the brand has no address yet). - A row that is On public site has Visit the live page and Take down from the public site in its ⋯ menu.
A brand serves one knowledge base at a time. Putting one up automatically takes the previous one down. The one that comes down is neither deleted nor forgotten by the AI — it just stops being reachable at the address.
Page structure
Home page
The header carries your logo, the question "How can we help?" and a large search bar. Below it, top-level categories are shown as cards with:
- Category name
- How many sub-categories and articles it holds
- Its description, trimmed to three lines
Category page
Opening a category shows what is inside it:
- Sub-categories as cards, each with its own counts and description
- Articles listed with a document icon and title
- Breadcrumb navigation back up the tree
Categories can be nested, so you can organize content hierarchically (for example Getting started > Account setup).
Article page
Each article shows:
- The full breadcrumb trail
- The article title and its formatted content
- Related articles from the same category
- A rating box where visitors give feedback
- An image viewer that opens a fullscreen carousel when a visitor clicks any image
Search
The search bar sits in the header on every page. As visitors type, a dropdown appears:
- Top Articles when the box is focused but still empty — the first five published articles in the order you arranged them
- Search results as they type — one list, with articles matched on their title first and articles matched on their text after them. A text match shows a short excerpt with the matching words highlighted; a title match highlights the words in the title instead
Results settle a moment after the visitor stops typing, instead of flickering on every keystroke.
Languages
Each knowledge base has one language it is written in, plus any extra languages you add to it. When there is more than one, a language switcher appears in the header and the address changes with it:
https://<your-brand-address>.yaplet.help/k/en → English
https://<your-brand-address>.yaplet.help/k/es → Spanish
The language in the address is checked on load. A visitor who lands on a language this knowledge base does not have is sent to its main language.
Branding and styling
The logo in the header is the brand's logo, set at Brand → Brand settings → General → Logo → Brand logo — the same logo used on the public documentation site and the public roadmap. If the brand has no logo, the chat widget's own logo is used instead; if there is neither, the header shows the words "Knowledge Base".
The colors come from the brand's chat widget: backgrounds, text, borders, buttons and accents all follow the choices you make under Brand → Chat widget → Style — the widget color, your brand colors and how your color is painted. The wide band at the top of the page, behind the title and the search box, is painted with the widget's Color layer, so the same paint that sits behind the widget's greeting decorates this page's header. A brand with no chat widget gets the default styling.
The chat widget on these pages
When the brand has a chat widget, it is embedded on the knowledge base pages, so visitors can start a conversation at any time. Two more things follow from having one:
- The widget's own help tab shows whichever knowledge base is on the brand's address, so visitors can browse and read articles without leaving the chat.
- The widget can show a link to your Documentation site at the top of that help tab. The switch is Link to Documentation, under Brand → Chat widget → Widget tabs.
What the AI answers from
Publishing an article is what puts it into the brand's AI knowledge, and it happens immediately — no chat widget and no AI agent have to exist for it. Unpublishing takes it back out.
What the brand's AI answers from is everything on its Knowledge screen, not just the knowledge base that happens to be on the public address. A knowledge base you have taken down still feeds answers in chat, on phone calls and in the inbox's suggested replies.
Article ratings
Each article ends with a rating box asking "Did this article answer your question?", with three buttons:
| Rating | Icon | What it means |
|---|---|---|
| Positive | 😁 | Yes, it helped |
| Neutral | 😐 | It was okay |
| Negative | 😞 | No, it didn't help |
The buttons lock after one click, so a visitor rates an article once per page view. Use the totals to find the articles that need rewriting.