Documentation
Versioning
Each published spec is a version. Readers switch between versions from the version picker, and every version keeps its own endpoint pages.
How it works
- Publish a spec
Each published spec becomes a version readers can select.
- Set the default
The default version is what a reader sees when they arrive without choosing one.
- Readers switch
The picker moves between versions. Endpoint pages are version-scoped, so v1's reference stays exactly as v1 shipped.
Guides are not version-scoped
This is the part worth understanding before you rely on it.
Endpoint pages are generated per spec, so they're versioned for free. Guides are hand-written and shared: the same guide shows to a reader on v1 and a reader on v3.
A quickstart with a v3-only endpoint in it is wrong for the reader on v1, and nothing flags it.
Two ways to live with that:
Navigation
Version-scoped navigation is derived automatically, because the endpoints differ per version. A custom navigation applies to the project-wide sidebar; guides stay pinned across versions. See Navigation.
Versioning and SDKs
Docs versions and SDK versions are related but separate. A reader on docs v1 can be running SDK v2. See SDK versioning.