Skip to content

Reorganize the API reference and developer tools navigation - #972

Open
letstokenize wants to merge 1 commit into
mainfrom
api-reference-ia
Open

letstokenize wants to merge 1 commit into
mainfrom
api-reference-ia

Conversation

@letstokenize

Copy link
Copy Markdown
Contributor

Summary

The API reference now uses the same names as developers.tempo.xyz and Tempo Console. Endpoints are grouped by product instead of by internal API split, and the SDKs and CLI sit under Get Started. Every page and endpoint is still reachable; duplicates are merged and their URLs redirect.

Changes

  • API reference: a top-nav link of its own. Sidebar sections are API reference, Accounts, Earn API, Routes API, Zones API, Data API, Console (in Console app order) and MPP. Guides sit inside the endpoint group they explain, and each page is listed once.
  • Get Started: new Tempo CLI and Tempo SDK sections. The APIs & SDKs hub (/docs/tools) and the header's Docs link are removed.
  • CLI: one format across all pages, plus a new tempo api page. Duplicate wallet pages are merged into Wallet and Recipes.
  • Moves: the Tempo API client moves to /docs/sdk/typescript/api-client. The hosted Fee payer and the self-hosted relay handler now link to each other.
  • Redirects: every moved or merged URL redirects, in vocs.config.ts and vercel.json.
  • Implementation: endpoint grouping is applied by regroupApiTags in vocs.config.ts. New sidebar options are added through patches/vocs@2.8.5.patch.

Testing

  • pnpm check, pnpm check:types, and pnpm test (1,188 passed)
  • Sidebar audit against production: all 188 endpoints are present, and duplicate links drop from 19 to 0

Follow-ups

  • Move the endpoint grouping into the tempoxyz/api OpenAPI spec (src/apps/data/App.ts, src/apps/management/App.ts), then delete regroupApiTags
  • Update the docs skill in tempoxyz/plugins

@vercel

vercel Bot commented Oct 11, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
tempo-docs Ready Ready Preview Oct 11, 2026 6:54pm UTC

Request Review

Group the API reference by product (Accounts, Earn API, Routes API, Zones
API, Data API, Console, MPP) instead of internal API splits, nest guides in
the endpoint groups they explain, and list each page once. Move the SDKs
and CLI into Get Started, give the API reference its own top-nav link, and
redirect the retired APIs & SDKs hub.

Standardize the CLI pages, add a `tempo api` page, merge duplicate wallet
pages, move the Tempo API client under the TypeScript SDK, and fix sidebar
and header spacing. Redirect every moved or merged URL.

This branch was successfully deployed

1 active deployment
Preview — 9d8b2a8b Deployed Oct 11, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant