Drafts and publishing
Edits in API Studio are drafts. Readers keep seeing the last published version until you press Publish, so you can work on a change for as long as you need.
What needs Publish
These stay in your draft until you publish:
- Page titles, content, icons, badges and lifecycle
- Endpoint descriptions, code samples and deprecation
- Endpoints you add or delete
- Tabs, folders and the order of the sidebar
- The home page
- Redirects
A dot in the navigation marks anything with unpublished changes.
What applies on save
Site-wide settings take effect when you save them. There is nothing further to publish.
- Appearance, including your logo and fonts
- Nav buttons and social links
- SEO settings
- Feedback, playground and AI chat settings
- Custom code and custom components
- Browser agents
If you are preparing a rebrand, change the theme last. It reaches readers the moment you save it.
What publishing does
The publish dialog lists what will change. Once you confirm:
- Your pages go live
Each draft becomes the live page.
- New and deleted endpoints reach your spec
Publishing writes them into the current spec as a new spec version, so your SDKs and MCP tools pick them up the ordinary way.
- The site updates
Tabs, the home page and redirects move together, so a rename and the redirect that protects its old address go live at the same moment.
Publishing needs the Publish permission. See organizations and roles.
Docs releases
Docs releases lists every publish from API Studio, newest first, and marks the one that is Live.
Publishing does not release an SDK
API Studio and SDK Studio publish separately. To ship an SDK, publish from SDK Studio.
From the CLI
Pages, guides, the nav and draft endpoints each have a publish command, such as octri docs pages publish and octri docs nav publish. octri docs releases lists the release history.