Skip to content

fix(docs): resolve broken API reference links and legacy startReward references - #824

Open
vhtgzzl wants to merge 1 commit into
tempoxyz:mainfrom
vhtgzzl:fix/broken-api-links-and-legacy-tip20-rewards
Open

fix(docs): resolve broken API reference links and legacy startReward references#824
vhtgzzl wants to merge 1 commit into
tempoxyz:mainfrom
vhtgzzl:fix/broken-api-links-and-legacy-tip20-rewards

Conversation

@vhtgzzl

@vhtgzzl vhtgzzl commented Aug 19, 2026

Copy link
Copy Markdown

Summary

This PR addresses two areas of documentation integrity across the Tempo documentation site (\docs.tempo.xyz):

  1. Resolves 16 Broken Internal API Links (/docs/api/*\ 404 Routes):

    • Several pages (\src/pages/docs/api.mdx, \src/pages/docs/api/faq.mdx, \src/pages/docs/api/indexer-api.mdx, \src/pages/docs/server/relay-handler.mdx) previously referenced subroutes such as /docs/api/activities, /docs/api/webhooks, /docs/api/balances, /docs/api/funding/quotes, /docs/api/funding/transfers, /docs/api/funding/deposit-addresses, /docs/api/exchange, /docs/api/indexer, and /docs/api/verified-tokens.
    • These endpoints are hosted under the unified OpenAPI reference page (/docs/api/reference). All links are updated to their canonical OpenAPI tag anchors (/docs/api/reference#tag/...).
  2. Clarifies Legacy \startReward\ References in Protocol Specifications:

    • \src/pages/docs/protocol/fees/spec-fee.mdx: Removed deprecated \startReward\ from active TIP-20 fee-token inference method lists.
    • \src/pages/docs/protocol/transactions/spec-tempo-transaction.mdx: Removed \startReward\ from limited Access Key spending limit tracking scopes, matching current TIP-20 behavior post-T7/T8 upgrades.

Resolves #741

Changes Made

  • \src/pages/docs/api.mdx: Updated 7 links in Common Workflows to canonical /docs/api/reference#tag/*\ anchors.
  • \src/pages/docs/api/faq.mdx: Updated 4 links in FAQ answers to /docs/api/reference#tag/*.
  • \src/pages/docs/api/indexer-api.mdx: Updated \GET /v1/indexer/query\ and indexer reference links to /docs/api/reference#tag/indexer.
  • \src/pages/docs/server/relay-handler.mdx: Updated verified-token list links to /docs/api/reference#tag/tokens.
  • \src/pages/docs/protocol/fees/spec-fee.mdx: Omitted \startReward\ from TIP-20 fee preference detection.
  • \src/pages/docs/protocol/transactions/spec-tempo-transaction.mdx: Omitted \startReward\ from spending limit tracking.

Verification

  • Audited all internal markdown links across \src/pages/docs/\ to ensure zero broken routes.
  • Verified that all OpenAPI tags match the operations declared in
    eference.mdx\ and \�ocs.config.ts.
  • Ensured formatting adheres to Conventional Commits and Vocs guidelines.

@vercel

vercel Bot commented Aug 19, 2026

Copy link
Copy Markdown

@vhtgzzl is attempting to deploy a commit to the Tempo Team on Vercel.

A member of the Team first needs to authorize it.

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.

docs: clarify legacy startReward references after TIP-20 rewards deprecation

1 participant