Guides are the Markdown pages beside the API reference — getting started, authentication, pagination, and so on. They belong to a version and ship when the version ships. Publishing itself is described in
.
Open a version, go to
Guides
and click
Add guide
:
- Title — the heading readers see.
- Address — the reader URL
/v/{version}/guides/{slug}/. Unique within the version. - Summary — one or two sentences shown in navigation and search.
- Content — Markdown, exactly as in knowledge base articles: callouts,
asset: uploads, an automatic table of contents; the pane beside the editor is the server's own rendering. See for the syntax. - Parent guide — nest the guide under another one of the same version, or leave it at the top level.
The header shows how many guides your plan allows per version.
A guide has no published state of its own: what is live is whatever the version's last snapshot recorded. The one publication control a guide has is the
Include in the next publish
toggle — in the form and in each row's menu. Turn it off to hold a draft back while the rest of the version ships; turn it on when it is ready. The
Publish
tab counts how many guides are included.
The list shows the guide tree as readers get it. Use
Move up
and
Move down
in a row's menu to reorder among siblings; to move a guide under another parent, edit it and change
Parent guide. The new arrangement goes live with the next publish.
Every save creates a revision; an optional
Change note under
Advanced Settings
is stored with it, alongside the
SEO title and
SEO description. The
Revisions
list under the editor shows them all;
Roll back to this
writes an old revision back as the newest draft — history is never rewritten.
Delete
in a row's menu removes the guide from the workspace. Readers keep seeing the live snapshot until the version is published again, so nothing disappears from the site by accident.