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, nested as deeply as you need: for example, an API reference with one page per group of endpoints.

Each space shows its pages as a tree: in the main area when you open the space, and in the left sidebar while you edit a page. Click the arrow next to a page to show or hide its child pages. Hover over a page to see its actions: the full menu in the space view, and only add child page and copy link in the editor sidebar.

Creating pages

To create a page in the web app:

• Top-level page: Click New page in the space header, or + next to Pages in the editor sidebar. Start from a blank page or a template.
• Child page: Hover over a page in the tree and click its + button. The new page is nested under that page.

Each page requires a title and automatically gets a URL-friendly slug generated from the title. You can edit the slug when you create the page. Renaming a page from the page tree regenerates the slug, which changes the page's URL. Changing the title in the editor keeps the slug.

# Create a page via API (slug is optional; it is generated from the title)
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_page_id": null
  }'

Import Markdown

Open a space and click Import Markdown in the space header (editors only). Select files or a folder, check the preview, then click Import pages.

Choose .md or .markdown files, or a folder. Folders become parent pages; README and index files provide their content.

Existing pages keep their content. Importing the same source paths again reuses pages without duplicating them.

Only Markdown text is imported. Images and other attachments are skipped; local image and page links are not rewritten and may need fixing.

The editor

AgentDocs has a Markdown editor with live preview. Switch between Edit, Split and Preview with the buttons in the editor header. In Split view, you write Markdown on the left and see the rendered page on the right as you type. If you have viewer access, the page opens read-only.

To add an image, paste it or drag it into the editor. JPEG, PNG, GIF and WebP files up to 5 MB each are supported. Images count towards the workspace's storage: 50 MB on Free and 5 GB on Pro. Verify your email address before uploading.

Supported Markdown

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

Auto-save

Pages save automatically about half a second after you stop typing. The editor header shows "Saving..." and then "Saved". If someone else, or an agent, saves the page while you are editing, AgentDocs asks before it overwrites anything. See Real-time collaboration for details.

Version history

Every save creates a new version of the page. To see them, click the version number (for example v7) in the editor header.

From the version history panel, you can:

• See who made each change and when. Changes made by an agent show the name of its space token or connected app; edits made with an account API token show as "agent".
• Compare any version with the current text, or with the version before it
• Restore an earlier version (editors only). This saves its content as a new version, so nothing is lost.

Comments

Click the speech-bubble button in the editor header to open the page's comments. You can reply, mention people with @name and, as an editor, resolve a thread when it is done. The page tree shows how many unresolved comments each page has.

Proposed changes

An agent whose space token has the Read and propose edits permission cannot change pages directly. It submits a proposed change instead, and the published page stays as it is. The reviewer (by default the page owner, otherwise the workspace owner) gets a notice in their inbox. In the browser, they open Proposed changes on the page, compare the proposal with the current text, and choose Approve and publish, Request changes or Reject. Agent tokens cannot approve. If the page changed after the proposal was made, it has to be revised before it can be approved.

Page health, next to Proposed changes, shows who owns the page and when a person last reviewed it. Set a review interval to get reminders in the owner's inbox.

Page operations

In the space view, hover over a page in the tree and click ⋯ to open its menu:

Trash

Deleted pages, with their child pages, stay in the trash for 30 days. While a page is in the trash, its share links stop working. To bring a page back, click the trash icon (Deleted pages) in the space header and choose Restore. Anyone with edit access to the space can restore a page, or remove it at once with Delete forever, which cannot be undone.

Managing pages via the API

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

GET    /api/spaces/:spaceId/pages             → List pages (metadata; ?include=content, ?hierarchy=true)
GET    /api/pages/:pageId                     → Get a page (?include=comments,children)
POST   /api/spaces/:spaceId/pages             → Create a page
PUT    /api/pages/:pageId                     → Update title/content (send "version" to get 409 on conflict)
PATCH  /api/pages/:pageId/rename              → Change title and/or slug
PUT    /api/pages/:pageId/move                → Move to another parent or space
DELETE /api/pages/:pageId                     → Move a page and its children to the trash
POST   /api/pages/:pageId/restore             → Restore a page from the trash
GET    /api/pages/:pageId/versions            → List versions
POST   /api/pages/:pageId/restore/:version    → Restore an old version
POST   /api/spaces/:spaceId/import/markdown   → Import Markdown files

See the API reference for full request/response details.

PDF export Pro

On the Pro plan, the workspace owner can download the whole workspace as one PDF book with a table of contents: open workspace Settings → Overview and click Export as PDF Book. Headings, lists, code blocks and tables keep their formatting; images are replaced by [Image: alt text] placeholders.