API versions
How Carina docs version channels map to protocol catalogs and the 0.8 release line.
Carina docs ship two channels. Narrative guides are shared; the method catalog and version banner track the selected channel.
Channels
Section titled “Channels”| Channel | Badge | Catalog file | Intent |
|---|---|---|---|
0.8.x | stable | /data/rpc-catalog-0.8.x.json | Docs surface for the 0.8 release line (current product) |
next | preview | /data/rpc-catalog-next.json | Tracks monorepo protocol/jsonrpc/methods.json at head |
The header Version control stores your preference in localStorage and sets data-docs-version on <html>.
Content tree model
Section titled “Content tree model”apps/docs/ src/content/docs/ # shared narrative (EN + zh-cn) src/data/ rpc-catalog-0.8.x.json # stable pin (current release line) rpc-catalog-next.json # head pin public/data/ # same trees, fetchable by the browser- Narrative pages (guides, concepts) are shared across channels.
- Protocol registry is channel-specific JSON, regenerated by
pnpm sync-protocol. - Version-only blocks can use
data-version-only="next"(or0.8.x) on HTML elements; the version switcher toggles them.
Refreshing catalogs
Section titled “Refreshing catalogs”From apps/docs:
pnpm sync-protocolCommit the updated src/data/rpc-catalog*.json and public/data/* when the registry moves. The generator writes both channels from the same methods.json; freeze meaning comes from committing on a release branch, not from a separate source file.
Try it
Section titled “Try it”On Method catalog, expand any method for:
- sample JSON / TypeScript / CLI tabs
- Try it — edit the JSON-RPC body, copy JSON/CLI, use Mock locally, or send remotely exposed methods through the authenticated WebSocket Gateway at
ws://127.0.0.1:8777/gateway
Source of truth
Section titled “Source of truth”- Protocol registry:
protocol/jsonrpc/methods.json - Catalog generation:
apps/docs→pnpm sync-protocol - Pins:
src/data/rpc-catalog-*.jsonandpublic/data/ - Related: Method catalog · JSON-RPC · API overview
- Open the stable method catalog or the next catalog; the header Version control moves between them while preserving filter and method state.
Was this page helpful?
What went wrong?
Thanks for the feedback.
One vote per page is recorded during this session.