Documentation

Your public web address

Every brand has one address of the form name.yaplet.help. This explains what visitors find there, how you choose which knowledge base and documentation set are served, and why taking something down never deletes anything.

Where the address is set

Each brand owns one web address, and you set it at Brand → Brand settings → Public address. The field is labelled Web address and its description reads: "Your knowledge base, documentation and public roadmap are all served from here."

Everything the brand publishes hangs off that one address:

  • https://<your-address>.yaplet.help/k — the knowledge base
  • https://<your-address>.yaplet.help/d — the documentation
  • https://<your-address>.yaplet.help/s — the public roadmap

Choosing what is served

Which knowledge base and which documentation set visitors actually find there is decided on Brand → Knowledge, in the Public site column.

A row says either Live or Hidden:

  • Live — this is the one visitors reach at your address. Its menu offers "Visit the live page" and "Take down from the public site".
  • Hidden — it still feeds the AI, it is just not served. Its menu offers "Show at (your address)".
A brand serves one knowledge base and one documentation set at a time. Putting one up automatically takes the previous one down. The displaced one is not deleted and not removed from the AI — it simply stops being served, and you can put it back at any time.

Taking something down

"Take down from the public site" leaves the address with nothing behind it, which is what you want when you have stopped offering a public knowledge base altogether. It asks you to confirm, and the confirmation says plainly what does and does not happen:

"Take "Knowledge Base" down from acme.yaplet.help? Visitors who open that address will see nothing until you put another knowledge base there. The articles themselves are not touched, and your AI keeps answering from them."

Afterwards you get a confirmation message saying "That address shows nothing now. The content is still here and your AI still answers from it."

What the top of the screen tells you

When the brand has an address and something is behind it, a strip sits above the table: Public site — acme.yaplet.help, followed by a button per served item — Knowledge base: (its name) and Documentation: (its name) — each of which opens the real page in a new tab.

Two warnings can replace it. They are never shown together, because the first one makes the second meaningless:

"This brand has no web address" — "Without one there is no public knowledge base, and links in your AI's answers have nowhere to point." A Set an address button takes you to Brand settings.
"Nothing is on acme.yaplet.help yet" — you have knowledge bases, but none of them is on the address, so visitors who open that page see nothing. Put one there with "Show at…" in its row menu; that also fills the chat widget's Help tab.

No chat widget is needed

The address belongs to the brand, not to the chat bubble. A brand with no chat widget anywhere can still serve a full public knowledge base and documentation site, and deleting the chat widget leaves the address and everything on it working — the customer's pages simply lose the bubble. What does not survive is the widget's own history: its chats, messages, events, visitors, session replays and banner campaigns are deleted with it.

Renaming the address

Changing the address is confirmed, because it moves every public link at once. The dialog says: "Every public link moves from old.yaplet.help to new.yaplet.help. Links already shared — in emails, in search results, on your own site — stop working right away, and the old address becomes free for someone else to take."

One class of link is safe. The links your AI quotes inside its own answers are built at the moment it answers, from whatever address the brand has right now, so a rename never leaves a stale link in an AI reply. Links people have already saved are the ones that break.

This is not publishing

Live and Hidden are not the Published switch. Live and Hidden decide which whole source — which knowledge base, which documentation set — visitors reach at your web address. Published is a separate switch on each individual article, on each documentation page and on each documentation category, and it decides whether that item appears at all and whether the AI can read it. (Knowledge base categories have no Published switch of their own.) Taking a knowledge base down from the public site publishes nothing and unpublishes nothing; every article inside it stays exactly as it was, and the AI keeps answering from all of them.