Documentation
Navigation
The sidebar is built for you and stays correct as your API grows. You can also take control of it when the automatic order isn't the story you want to tell.
The default
With no custom navigation, the sidebar is derived automatically:
- Guides first
Your guide groups, in the order you set, above everything else.
- Then endpoints
Grouped by the first segment of their URL path, sorted by path and then by method.
This needs no maintenance: a newly ingested endpoint appears on its own.
Custom navigation
The nav editor lets you reorder sections, rename items, hide them, and weave guides in among endpoints.
A hidden item disappears from the sidebar but stays reachable at its URL. To make a page genuinely private, unpublish it or use access control.
Tabs
For larger sites, a tabbed layout splits the docs into independent top-level sections, each with its own sidebar.
| Tab kind | Behaviour |
|---|---|
reference | The API reference. While visible, auto-appends every endpoint you don't explicitly place |
content | A curated tab. You choose what goes in |
link | An external link in the top nav, with no sidebar |
changelog | Your release feed at /changelog. A nav position with no sidebar of its own, shown once the project has entries |
The reference and changelog tabs are permanent: you can reorder and hide them, but not rename or delete them. Hiding is how you take either one off the public nav.
Endpoints you don't place land in the reference tab; guides you don't place land in the first visible tab with a sidebar. So you can adopt a custom nav gradually instead of all at once.
Only visible tabs collect what the IA doesn't place, and nothing re-homes the endpoints the reference tab was carrying. Hide it and they leave the sidebar altogether while staying reachable at their URLs. Place the ones you want kept in another tab first, or leave the reference tab visible and hide it per route.
Ordering
Groups and the guides inside them each carry an explicit order. Endpoints inherit their order from the spec's paths.
The most useful first page is rarely the one that sorts first. Put the overview at the top and the reference material at the bottom, whatever their names.
Versioned navigation
Version-scoped navigation is derived automatically, because endpoints differ between versions. Guides are not version-scoped, so they stay pinned across all of them. See Versioning.