Documentation
Introduction Dashboard
Widget Public Pages

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:

Left Panel: Documentation Hierarchy

The left panel displays a tree structure showing all documentation pages organized hierarchically.

Navigation Features:

  • Category header showing the current category name
  • Search functionality to quickly find specific pages
  • Collapse to manage tree visibility
  • Focus button to expand the path to the currently selected page

Tree Structure:

  • Root pages appear at the top level
  • Child pages are nested under their parent pages
Each page in the tree includes a context menu (three dots) with options to move pages up/down, add child pages, or delete pages.

Page Management:

  • Add child pages using the "+" buttons that appear under expanded parent pages
  • Reorder pages using the up/down arrows in the page menu
  • Delete pages with options to handle child pages (delete all or move children up)
  • Add root pages using the 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

Right-click any page or use the three-dot menu for actions

Step 4: Add New Pages

Click "+" buttons to add child pages or use "Add Root Item" for top-level pages

Parent documents can serve as organizational folders even without content. Empty parent pages act purely as folder-like containers to organize child pages hierarchically. When a parent document contains content, clicking it will open the article for editing while still showing its child pages in the tree structure.

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 field for the page title
  • Description field for a brief page description
  • Published toggle - Control whether this page is publicly visible and available in AI knowledge

Content Editing: The main content area uses a markdown editor for creating and editing documentation content.

For detailed information about using the markdown editor and its features, see our comprehensive markdown editor guide.

AI Assistance Tools:

AI Generate

Modal for creating new content, continuing existing content, or editing current content with AI assistance.

AI Title

Generate page titles based on content using AI.

AI Description

Generate page descriptions using AI.

Actions:

  • Save button to persist changes to the page
  • Share button to share the documentation page
For detailed information about sharing documentation pages and generating public links, see our comprehensive sharing guide.

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

Click the save button to persist your modifications

The interface automatically expands the hierarchy tree to show the path to your currently selected page, making it easy to understand the page's position in the overall documentation structure.
Remember to save your changes regularly. The editor will prompt you if you try to navigate away with unsaved changes.
Previous Docs and CategoriesNextSharing