Tour of the studio
API Studio is where you build your docs site. Pick something on the left, edit it in the middle, and see the result as readers will.
The three panels
Your tabs, folders, pages and endpoints, on the left. The tree you arrange is the sidebar readers get.
Whatever you've selected, in the middle. It shows the real page, not a raw-text approximation.
On the right: Request code for an endpoint, and Files for the whole site as files.
On a narrow screen, the panel button in the studio header opens the side panel as a drawer.
Building the navigation
Add to the tree from the + menu:
| Add | What it does |
|---|---|
| New page | A hand-written MDX page. See writing guides |
| New endpoint | An operation that goes into your spec when you publish. See editing endpoints |
| New folder | A group in the sidebar, which you can nest |
| External link | A sidebar row that goes to another site |
| Add new tab | A top-level section with its own sidebar |
Drag anything to rearrange it. Each row's ⋯ menu has what applies to that row: Rename, Duplicate, Move to, Copy to, Copy page URL, Set as home page, Remove from tab and Delete.
See navigation for how tabs, folders and URLs relate.
Editing a page or endpoint
Both offer two modes:
- Visual edits the rendered page. On a page, type
/to add callouts, cards, images, videos and steps. - MDX edits the source, with a toolbar and an Insert menu for components.
Switch between Editor and Preview to see the finished page. Your edits save automatically as a draft.
Docs settings
The settings at the foot of the navigation cover the whole site. Your role decides whether you can change them or only view them.
| Setting | Read about it in |
|---|---|
| Appearance | Appearance |
| Navigation | Navigation |
| API server and Playground | API playground |
| SEO | SEO |
| AI chat | Search and AI chat |
| Feedback | Analytics and feedback |
| Browser agents | llms.txt and browser agents |
| Components | Custom components |
| Docs access | Access control |
| Custom code | Custom code |
| GitHub sync | GitHub sync |
When you're ready
Nothing you edit in the stage goes live until you press Publish. Drafts and publishing explains exactly what that moves.