docs: fix broken anchor links#743
Open
oluwadareab12 wants to merge 1 commit into
Open
Conversation
Several internal links pointed to anchors that do not exist on their target pages, so they landed at the top of the page instead of the intended section. Most were headings that had since been renamed — for example "Handling ETH Balance Checks" became "Handling ETH (Native Token) Balance Checks", and "Rebalance liquidity" became "Rebalance pools". Point each link at the anchor that actually exists. Link text and surrounding prose are unchanged.
|
@oluwadareab12 is attempting to deploy a commit to the Tempo Team on Vercel. A member of the Team first needs to authorize it. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What was wrong
Ten internal links pointed to anchors that don't exist on their target pages. Since the target heading isn't there, these links silently land at the top of the page instead of the intended section. Most are headings that were renamed at some point after the link was written (e.g. "Handling ETH Balance Checks" → "Handling ETH (Native Token) Balance Checks"); a couple pointed at the wrong page entirely.
Fixes
protocol/tip20/overview.mdx(line ~101)/docs/protocol/tip403/spec#tip-20-token-roles/docs/protocol/tip20/spec#tip-20-rolesprotocol/tip20/overview.mdx(line ~107)/docs/protocol/tip20/spec#roles/docs/protocol/tip20/spec#tip-20-rolesprotocol/tips/tip-1007.mdx/docs/protocol/fees/spec-fee#fee-token-resolution/docs/protocol/fees/spec-fee#fee-token-preferencesquickstart/connection-details.mdx/docs/quickstart/evm-compatibility#handling-eth-balance-checks/docs/quickstart/evm-compatibility#handling-eth-native-token-balance-checksquickstart/developer-tools.mdx/docs/api/indexer-api#interactive-tidx-sql-example/docs/api/indexer-api#interactive-examplequickstart/evm-compatibility.mdx/docs/quickstart/integrate-tempo#tempo-transactions/docs/guide/tempo-transactionguide/issuance/manage-stablecoin.mdx(prose +<Card to=...>, 2 occurrences)/docs/protocol/tip20/spec#role-based-access-control/docs/protocol/tip20/spec#tip-20-rolesguide/issuance/use-for-fees.mdx/docs/guide/stablecoin-dex/managing-fee-liquidity#rebalance-liquidity/docs/guide/stablecoin-dex/managing-fee-liquidity#rebalance-poolsguide/stablecoin-dex/providing-liquidity.mdx/docs/protocol/exchange/exchange-balance#withdrawing-funds/docs/protocol/exchange/exchange-balance#withdrawing-from-the-dexguide/issuance/create-a-stablecoin.mdx/docs/quickstart/integrate-tempo#default-fee-token/docs/quickstart/evm-compatibility#consideration-1-setting-a-user-default-fee-tokenTwo items worth calling out explicitly:
protocol/tip20/overview.mdxline ~101 — the old link (/docs/protocol/tip403/spec#tip-20-token-roles) pointed at the TIP-403 spec, but the surrounding sentence ("TIP-20 includes a built-in RBAC system that separates administrative responsibilities: ISSUER_ROLE, PAUSE_ROLE/UNPAUSE_ROLE, BURN_BLOCKED_ROLE...") is describing TIP-20's own role system, word-for-word matching the## TIP-20 Rolessection in the TIP-20 spec. The next section on the page (### Tempo Policy Registry (TIP-403)) is a separate, later topic. I changed the target page, not just the anchor, to/docs/protocol/tip20/spec#tip-20-roles.guide/issuance/create-a-stablecoin.mdx— the old anchor (#default-fee-token) doesn't exist anywhere onintegrate-tempo. The sentence is "As we have configured our project to useAlphaUSD... as the default fee token" — a how-to statement about setting the fee token, not the abstract resolution algorithm.evm-compatibility.mdxhas#### Consideration 1: Setting a user default fee token, whose own text says "the simplest way to specify the fee token for a user is to set the user default fee token" — a direct match. I used that instead of the alternative candidate (spec-fee#fee-token-preferences, which documents the resolution algorithm and is already linked separately fromevm-compatibility.mdxitself). Flagging this one since it required judgment rather than a 1:1 heading-rename — happy to point it elsewhere if a maintainer disagrees with the read.Verification
Used a script that resolves each page's heading set (including headings pulled in via imported
.mdxsnippets) and slugifies them with github-slugger semantics (lowercase, punctuation dropped, spaces → hyphens), then flags every internal[text](/path#anchor)andto="/path#anchor"link whose anchor isn't in its target page's heading set.manage-stablecoin.mdxhas the same broken anchor twice — once in prose, once in a<Card>).Also ran
pnpm check:types(tsgo --noEmit) — clean.pnpm buildfails, but only at thevocs:llmsplugin's OpenAPI-spec network fetch step (ConnectTimeoutErrorreaching an external host) — unrelated to this change and a pre-existing environment/network constraint, not something a content-only anchor fix touches..mdxfiles are excluded from this repo's biome config, so there's no lint/format step that applies to prose content either.Closes nothing (no tracking issue — found by scanning the repo, per your instructions).