Custom documentation
Write, review, schedule and publish documentation pages for your APIs and integrations, with revisions, rollback and a changelog.
Updated 07/10/2026
On this page
What you can build
The documentation workspace lets your team keep the guides for its own APIs and integrations next to the integrations themselves:
Documentation sites group pages for a project or API product, with a name, a description and a visibility setting.
Pages are written in Markdown, linked to a section, optionally nested under a parent page, and optionally tied to an API version.
Revisions keep every edit. Readers only ever see the published revision, so drafts never leak.
Changelog entries announce what changed, with dates, deprecation and sunset information and a migration guide link.
Published pages are also what the MCP tool get_documentation_page, the nexra://docs/{slug} resource and the AI assistant use as context, so agents answer from the same source as your readers.
Create a site
Open Dashboard → Documentation and choose New site.
Enter a name, an optional project and description, and the visibility: private (you and administrators), workspace (every member) or public.
Open the site and add pages.
Only workspace owners and administrators can set a visibility other than private.
Write a page
Each page has a title (up to 160 characters), a navigation section (up to 80), a search description (up to 300) and Markdown content (up to 50,000 characters). Switch between the visual editor and Markdown at any time, and use Preview to check the result.
Supported formatting:
| Write | Renders as | |||
|---|---|---|---|---|
## Heading, ### Subheading | Headings with copyable anchor links and an "On this page" outline | |||
- item | Bullet list | |||
1. step | Numbered step | |||
**bold**, ` code | Bold text and inline code | |||
[label](https://…) or [label](/docs/…) | Links (HTTPS or site-relative only) | |||
| Fenced code blocks with a language | Code with a copy button | |||
| a | b | ` rows | Tables |
> note | Callout |
Review and publish
Pages move through draft, in_review, scheduled, published and archived:
Save draft. Every save creates a new revision and returns the page to draft.
Submit for review.
Publish now, or schedule a future publication time, with an optional change summary.
Unpublish returns a page to draft; Archive retires it; Restore brings an archived page back as a draft.
Revision history lists every version; Rollback copies an earlier revision into a new draft for review.
| Role | Can do |
|---|---|
DOCUMENTATION_EDITOR, DEVELOPER | Create and edit drafts |
OWNER, ADMIN | Also publish, schedule, archive, change visibility and manage the changelog and API catalogue |
Scheduling, unpublishing, archiving and revision history are in Dashboard → Admin → Docs.
Changelog
Changelog entries have a version, a type (added, changed, fixed, deprecated, removed or security), a title, a body, an effective date and an optional breaking-change flag. Deprecations and removals can carry a sunset date (after the effective date) and a migration guide, which must be an HTTPS URL or a /docs/ page. Entries follow the same review, schedule and publish workflow and appear at /changelog and in search.
API reference from OpenAPI
Administrators import an OpenAPI 3.0 or 3.1 document (JSON, up to 1 MB, 500 paths and 1,000 operations) for an API product version and publish it. Publishing refreshes the API reference, search results and the downloadable OpenAPI, Postman and SDK artefacts for that product.
Current limitations
Pages published by your workspace power your agents and assistant; public hosting of workspace sites on their own URL or custom domain is not available yet.
Logo and branding settings, page re-parenting and navigation ordering can be set when a page or site is created, but not edited from the console yet.
Pages are not generated automatically from connections or OpenAPI imports. Each connector's reference lives in the connector directory.