Set up your documentation site

Updated May 22, 2026

1. Create a documentation

  1. Go to Dashboard → Documentation.
  2. Click New Documentation.
  3. Enter a title (e.g. "Developer Guide" or "API Reference").
  4. Save. The documentation appears in the list.

You can create multiple documentations — one per product, one per audience, or one per language. Each documentation is independent with its own categories, pages, and widget connections.

2. Add categories

Categories appear as navigation tabs on the public documentation site. Think of them as chapters: "Getting Started", "API Reference", "Configuration".

  1. Click into your new documentation.
  2. Click New Category.
  3. Enter a name and optional description.
  4. Repeat for as many categories as you need.

If you have only one category, the navigation tab bar is hidden on the public page for a cleaner reading experience. See how to organize documentation categories for ordering and best practices.

3. Add pages

Inside a category, you build a page tree — pages can have child pages, which can have their own children, for as many levels as you need.

  1. Open a category (click its name in the documentation view).
  2. In the left tree panel, click Add Root Item (at the bottom of the panel).
  3. Enter a title in the right editor panel and write your content in the markdown editor.
  4. To add a child page, open the three-dot menu on the parent page and choose Add Child. For pages that already have children, an inline + Add Child link also appears at the end of the child list.

4. Connect to a widget

Documentation is only publicly accessible when it is connected to a widget. The widget provides the public URL and controls the visual branding.

  1. Go to Dashboard → Widgets → [your widget].
  2. Open the General tab and scroll to the Connections section.
  3. Select your documentation from the Documentation dropdown, then save.

Your documentation is now accessible at https://{widget-subdomain}.yaplet.help/d/. You can change the documentation's primary language (defaults to English) and upload light/dark logos from Dashboard → Documentation → [your docs] → Settings.

5. Publish

Content must be explicitly published before it is publicly visible. Publishing is a two-step process: first the category, then the pages inside it. See Publish documentation to a public URL for the full publish flow and bulk-publish shortcuts.

Did this article answer your question?