Step 1 — Connect to a widget
Before anything is publicly accessible, the documentation must be connected to a widget. The widget supplies the public URL and the visual branding.
- Go to Dashboard → Widgets → [your widget] → Settings.
- Find the Documentation section and select your documentation.
- Save.
Your documentation will be at https://{widget-subdomain}.yaplet.help/d/ once categories and pages are published.
Step 2 — Publish a category
Unpublished categories are invisible to visitors and to AI. To publish a category:
- Click into your documentation and open the category.
- In the category header, find the Published toggle and enable it.
- Or open Category Settings and toggle Published there.
Unpublishing a category hides all its pages immediately — even pages that were individually published. Republishing the category does not automatically republish its pages.
Step 3 — Publish pages
Each page has its own Published toggle in the right editor panel. A page can only be published if its category is already published.
- Select the page in the left tree.
- Toggle Published in the editor panel header.
- Save.
Published pages appear in the public site navigation and are indexed for AI knowledge automatically.
Share a link to a page
Once a page is published, click the Share button in the editor to get a link. Two link types are available:
- Direct link — human-readable URL using category and page names. Example:
/d/getting-started/installation. Good for SEO. Breaks if the page or category is renamed. - Fixed link — permanent URL using the page ID. Example:
/d/redirect?id=abc123. Never breaks. Use this for links you embed in your product, docs site, or send to customers.
Bulk publishing
When you have many pages to publish at once, use the bulk options instead of toggling pages one by one:
- From the category header: three-dot menu → Publish all pages (requires the category to be published first). This publishes every unpublished page in the category.
- From a parent page: three-dot menu on the page in the tree → Publish all children. You can choose between publishing direct children only, or all nested descendants.
Bulk operations skip pages that are already in the target state. Only newly published pages are processed for AI knowledge, keeping the operation efficient.