Skip to content

docs(routes): add FX swap guide and example - #1137

Merged
JasonwLi merged 3 commits into
mainfrom
docs/routes-fx-swaps
Nov 13, 2026
Merged

JasonwLi merged 3 commits into
mainfrom
docs/routes-fx-swaps

Conversation

@JasonwLi

@JasonwLi JasonwLi commented Nov 13, 2026 •

Copy link
Copy Markdown
Contributor

Adds an FX section to the Routes docs: a walkthrough for swapping a stablecoin in one currency for a stablecoin in another on Tempo, and a terminal recipe that runs the same steps.

Changes

  • src/pages/docs/routes/fx.mdx (new, "Swap currencies"): how FX routes differ from other routes, the six steps from account check to completed transfer, managing the account list, and quote errors.
  • src/pages/docs/routes/examples/fx.mdx (new, "FX swap example"): the same flow with curl and jq.
  • vocs.config.ts: an FX group in the Routes sidebar, and the example under cURL examples.
  • src/pages/docs/routes.mdx: one sentence pointing same-network currency swaps to the new page.

Notes for review

  • Both pages use operations from the API reference: the account check by tokens (getPropAmmTokensAccountAccess, added with organization sponsor lists), getPropAmmAccountAccess, preparePropAmmAccess, and the Routes transfer operations.
  • Behavior stated on the page was checked against the live API: recipient must equal sender, an unlisted sender gets 404 quote_not_available, and quotes expire within seconds.
  • The pool address, pair index, and sponsor ID are placeholders that Tempo provides with access.
  • The new pages have no ogImage yet.

Checks

pnpm check, pnpm check:types, pnpm test, pnpm build, pnpm check:markdown, pnpm check:anchors, and the generic-H2 scan pass. Both pages were viewed in the production preview.

@vercel

vercel Bot commented Nov 13, 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 Nov 13, 2026 10:04pm UTC

Request Review

@JasonwLi
JasonwLi marked this pull request as ready for review November 13, 2026 21:54

@claude claude Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nothing blocking. The comments below are optional suggestions. There is no need to push a fix for them before merging.

Comment thread src/pages/docs/routes/fx.mdx Resolved

@claude claude Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code review found no issues

No high-confidence issues detected in this change.

@JasonwLi
JasonwLi merged commit 2f500d4 into main Nov 13, 2026
16 of 17 checks passed
@JasonwLi
JasonwLi deleted the docs/routes-fx-swaps branch November 13, 2026 22:06

This branch was successfully deployed

1 active deployment
Preview — ca67afed Deployed Nov 13, 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