Building Docs
The documentation editor provides a split-pane interface for managing and editing documentation pages, featuring a hierarchical tree view on the left and a content editor on the right.
Layout Overview
The documentation editor consists of two main panels that work together to provide a comprehensive editing experience:
/dashboard/documentation/<id>/…), so existing bookmarks and links still open it. What changed is the trail around it: the breadcrumb now reads (your brand) › Knowledge › the documentation set › the category, and the back arrow returns to that set's list of categories.Left Panel: Documentation Hierarchy
The left panel displays a tree structure showing all documentation pages organized hierarchically.
Navigation Features:
- The bar at the top of the panel shows the current category name with a colored status dot (green when everything is published, yellow when some pages are not, red when the category itself is not published) and a ⋯ menu for category-wide actions: Search documentation, Publish all pages and Unpublish all pages
- Focus on selected item (a button with a crosshair icon) expands the path to the currently selected page
- Collapse all collapses all expanded tree nodes
Tree Structure:
- Root pages appear at the top level
- Child pages are nested under their parent pages
Page Management:
- Add child pages with Add Child in a page's menu, or with the Add Child buttons that appear under expanded parent pages
- Reorder pages with Move Up and Move Down in the page menu
- Delete pages with options to handle child pages (Delete parent and all children, or Delete parent, move children to parent's parent)
- Add root pages with the Add Root Item button at the bottom of the tree
Step 1: Navigate to Category
Select a documentation category to view its pages
Step 2: Expand Tree Structure
Use expand/collapse controls to navigate the hierarchy
Step 3: Manage Pages
Use a page's three-dot menu for actions
Step 4: Add New Pages
Use Add Child to add a page under another page, or Add Root Item for top-level pages
Right Panel: Content Editor
When a documentation page is selected from the hierarchy tree, the right panel displays the content editor with comprehensive editing tools.
Page Metadata:
- Title for the page title
- Description for a brief page description
- Published switch - Control whether this page is publicly visible and part of the brand's AI knowledge. It takes effect when you press Save, and then the AI half is immediate — no chat widget and no AI agent need to exist for it
Content Editing: The main content area below the form uses a markdown editor for creating and editing documentation content.
AI Tools:
AI Content
One assistant for writing, improving, or continuing the page — describe what you want (or pick a quick action like Continue writing, Improve, Fix grammar or Shorten, which appear once the page has content), optionally attach related documentation pages or knowledge base articles as context, and press generate. The result goes straight into the editor, and an Undo button in the confirmation message lets you take it back.
AI Title
Generate page titles based on content using AI.
AI Description
Generate page descriptions using AI.
Actions:
- Save persists your changes to the page. It sits in the bar above the form.
- Share shares the documentation page. It appears when the brand has a chat widget and is grayed out until the page is published.
Usage Workflow
Step 1: Access Category
Navigate to a documentation category within your documentation
Step 2: Select Page
Click on a page from the hierarchy tree on the left to open it in the editor
Step 3: Edit Metadata
Update the page title and description in the form fields
Step 4: Edit Content
Use the markdown editor to modify the page content
Step 5: AI Enhancement
Use AI tools to generate, continue, or improve content as needed
Step 6: Save Changes
Press Save to persist your modifications