Documentation

Share links

Every article, page, category, knowledge base and documentation set can be handed out as a public link. This explains the two kinds of link the share dialog offers, which one survives a rename, and why an unpublished item leads nowhere.

Anything you publish can be handed to someone as a plain web link — an article, a documentation page, a whole category, or the entire knowledge base or documentation set. You never build these links by hand. Open the item's menu and choose Share, and the dialog gives you the finished address with a button to copy it.

The dialog is titled after whatever you clicked: Share Article, Share Category, Share Page, Share Documentation or Share Knowledge base.

Which address the link uses

Every link points at your brand's public web address — your-address.yaplet.help — the same one described in Your public web address.

At the top of the dialog you will see either a plain name or a dropdown:

  • A name — this knowledge base or documentation set is attached to one chat widget, so there is only one address it can be shared from. The name is shown for information; there is nothing to choose.
  • A dropdown — it is attached to more than one, and each one has its own public address. Pick the one you want the link to go through. The content is the same either way; only the address and the design of the page around it differ, because a shared page takes the appearance of the widget it was shared through.
If the dialog says "No widgets available for this knowledge base." (or "…for this documentation."), the source is not attached to any chat widget yet, so it has no public address to be shared from. Attach it first — see Knowledge bases or Documentation sets.

The two kinds of link

For a single article or a single documentation page you get two links and should choose deliberately. For a category, a whole knowledge base or a whole documentation set you get only the first kind — there is no fixed link for those.

Direct link — readable, but it moves

The address is built out of the names in the path as they are right now:

  • Knowledge base article — https://your-address.yaplet.help/k/en/getting-started/installation
  • Documentation page — https://your-address.yaplet.help/d/getting-started/installation

It reads well and search engines index it happily, which makes it the right choice for anything public-facing: a link in a chat reply, a post, or a page you want found on Google.

A direct link breaks the moment any part of the path is renamed — the language, the category name, the article or page title. Anyone holding the old link gets nothing. The dialog says the same thing: "Breaks if any of the above changes".

Fixed link — permanent, but opaque

The address carries the item's internal id instead of its names:

  • Knowledge base article — https://your-address.yaplet.help/k/redirect?id=…
  • Documentation page — https://your-address.yaplet.help/d/redirect?id=…

Nothing you do to the content's names or its position can break it. Rename the article, rename its category, move it somewhere else entirely — the link still lands on it, because it is resolved by id at the moment it is opened. The dialog calls this "Never breaks from reorganization".

The cost is that it tells a reader nothing and is worth nothing for search ranking.

Use a direct link when a person or a search engine will read it. Use a fixed link when it has to keep working unattended — inside your own documentation, in a saved reply, in a help button in your product, or anywhere in code. Every cross-link inside this documentation is a fixed link, for exactly that reason.

Unpublished items lead nowhere

A share link only works if the thing behind it is published, and for documentation that applies to the category as well as the page: an unpublished category takes its pages down with it, even the published ones. The link itself is generated regardless, so it is worth checking the Published switch before you hand one out.

Publishing is separate from whether the source is on your public address at all. A knowledge base that is Hidden still feeds your AI, but nothing inside it is reachable at your web address — so every share link from it leads nowhere until you put it back up. Your public web address explains that distinction in full.

Copying and opening

Each link sits in a box with two buttons beside it: Copy to clipboard, which turns into a tick when it has copied, and Open in new tab, which opens the real public page so you can see exactly what the person receiving the link will see.