Overview
Your OpenAPI spec becomes a browsable documentation site: three-column endpoint pages, nested schema trees, copy-ready code samples, and hand-written guides alongside the generated reference.
This page is a guide stored in Octri, authored in MDX, and served by the same renderer your published docs use. Every component in the component reference is one you can put in your own pages.
What you get from a spec
Parameters, request bodies, and responses rendered as expandable schema trees rather than a wall of JSON.
Request examples in every language you generate an SDK for, kept in sync with the spec.
A live request drawer on each endpoint, so readers can call the API without leaving the page.
Full-text search across endpoints and guides.
What you add yourself
Generated reference tells readers what an endpoint does. It can't tell them why, when, or in what order. That's what guides are for: MDX pages you write, organised into groups, rendered by the same engine as the reference.
Where to go next
Find your way around the three panels.
What needs a publish, and what applies on save.
Improve, add, hide and deprecate your reference pages.
Authoring pages beside your reference.
Match the site to your brand.
Serve docs from your own hostname.
From the CLI
Everything on this site can also be managed from a terminal. See docs commands.