Pages & Editor

Creating, editing, and organizing documentation pages.

Hierarchical Pages

Pages in AgentDocs are organized in a tree structure within each space. Any page can have child pages, allowing you to create deeply nested documentation hierarchies. This is perfect for structuring complex documentation like API references, multi-chapter guides, or knowledge bases.

The page tree is displayed in the left sidebar when you're inside a space. You can expand/collapse parent pages, drag to reorder (coming soon), and right-click for a context menu with additional actions.

Creating Pages

There are two ways to create a page:

• Top-level page: Click the "+ " button at the top of the page tree sidebar. This creates a new root-level page in the space.
• Child page: Right-click (or hover) on an existing page in the tree and select "Add child page". The new page will be nested under the selected page.

Each page requires a title and automatically gets a URL-friendly slug generated from the title. You can customize the slug during creation or later in the page settings.

# Create a page via API
curl -X POST https://agentdocs.eu/api/spaces/SPACE_ID/pages \
  -H "Authorization: Token YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Authentication Guide",
    "slug": "auth-guide",
    "content": "# Authentication\n\nThis guide covers...",
    "parent_id": null
  }'

The Split-Pane Editor

AgentDocs features a split-pane Markdown editor with live preview. The left pane is a text editor where you write Markdown, and the right pane shows a rendered preview that updates in real time as you type.

Supported Markdown Features

AgentDocs supports GitHub Flavored Markdown (GFM) with the following features:

Auto-save

Pages are automatically saved as you type. There's a brief debounce period (around 1 second of inactivity) before the save fires. You'll see a subtle save indicator in the editor toolbar confirming the save was successful.

Version History

Every save creates a new version of the page. AgentDocs maintains a full version history that you can access from the history button in the editor toolbar.

From the version history panel, you can:

• See who made each change and when
• Preview any previous version of the page
• Restore a previous version (creates a new version with the old content)

Page Operations

Right-click a page in the sidebar tree to access the context menu with the following actions:

Managing Pages via API

All page operations are available through the REST API. Here are the key endpoints:

GET    /api/spaces/:spaceId/pages          → List all pages in a space
GET    /api/pages/:pageId                   → Get a single page
POST   /api/spaces/:spaceId/pages           → Create a new page
PUT    /api/pages/:pageId                   → Update a page
DELETE /api/pages/:pageId                   → Delete a page

See the API Reference for full request/response details.

PDF Export Pro

Pro workspaces can export pages to PDF for offline sharing, printing, or archival. The PDF preserves your page formatting including headings, code blocks, tables, and images.