docs: fix 104 dead documentation links across all language trees - #187
Open
boleklebovski wants to merge 1 commit into
Open
docs: fix 104 dead documentation links across all language trees#187boleklebovski wants to merge 1 commit into
boleklebovski wants to merge 1 commit into
Conversation
docs.cosmos.network retired its /main, /master and old versioned .html trees; Tendermint's docs were superseded by CometBFT; and x/circuit was extracted from the cosmos-sdk monorepo after v0.50. 32 distinct URLs 404 as a result, in 104 places across 47 files. Each replacement was confirmed to return 200 with a topic-matching page title, every anchor was checked against the target page, and links that still resolve were left untouched. The three tx.proto references also had their line ranges re-derived, because two of them pointed past the end of an 83-line file. Signed-off-by: boleklebovski <160799963+boleklebovski@users.noreply.github.com>
Contributor
|
Important Review available on request
Reviews should be triggered manually for repositories with fewer than 10 stars. Select Trigger review above or comment ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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
1 participant
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.
Problem
32 distinct external documentation URLs referenced from these docs are dead (HTTP 404). They appear 104 times across 47 files, in all four language trees (root,
cn,jp,ko).Three separate causes:
docs.cosmos.networkretired the/main/,/master/and old versioned.htmltrees — 28 URLs.spec/abci/apps.htmlpage no longer exists anywhere — 1 URL.x/circuitwas extracted from the cosmos-sdk monorepo after v0.50, soblob/main/proto/cosmos/circuit/v1/tx.protonow 404s — 3 URLs.What I verified
x/bank,Setting up the keyring,ADR 036: Arbitrary Message Signature Specification. Status codes alone were not treated as sufficient./sdk/latest/totally-made-up-abcxyzreturn a real 404 on that host, so a 200 here means the page genuinely exists rather than an SPA fallback.id(#antehandlers,#message-routing,#step-1-antehandler,#3-add-genesis-accounts,#the-transaction-execution-pipeline,#broadcasting-a-transaction,#parameters).docs.tendermint.com/master/introduction/what-is-tendermint.html#intro-to-abci(6 occurrences),docs.tendermint.com/v0.34/tendermint-core/configuration.html(4), the baredocs.cosmos.network/anddocs.tendermint.com/links, and 107 of the 110cosmos-sdk/blob/...links.The proto citations needed more than a tag swap
The three
tx.protoreferences used line ranges from an older layout of that file:#L25-L75,#L77-L93,#L95-109. In every tag that still carries the file it is only 83 lines long, so two of those ranges point past the end of the file — the reference would render but highlight nothing.I re-derived each range from the current file so that every citation highlights exactly the message its heading names:
MsgAuthorizeCircuitBreaker#L25-L40(doc comment + message)MsgTripCircuitBreaker#L47-L60MsgResetCircuitBreaker#L67-L78I pinned the tag
x/circuit/v0.1.0, which this same file already uses for itsx/circuit/ante/circuit.goreference, rather than introducing a different pin. (As a side effect this also fixes#L95-109, which was missing the secondL.)Choosing replacement paths
Where a retired page has a current equivalent I used
/sdk/latest/..., resolved and confirmed one path at a time./sdk/latest/was reorganised relative to the old/main/tree, so a single prefix rewrite does not work — for example/main/basics/accountsbecomes/sdk/latest/learn/concepts/accounts, while/main/modules/bankbecomes/sdk/latest/modules/bank/README.Scope
URL text only. Every one of the 76 changed lines differs from the original in the URL alone — no prose, formatting or frontmatter was touched. (104 replacements land on 76 lines because some lines carry several links, such as the module list in
inj-coin.mdx.)All four language trees are updated in the same change so the translations do not drift out of parity — the same reason
docs(cn): sync ...PRs exist.Full mapping
cosmos/v0.46/run-node/keyring.htmlcosmos/sdk/latest/node/keyringcosmos/main/buildcosmos/sdk/latest/learncosmos/main/basics/accountscosmos/sdk/latest/learn/concepts/accountscosmos/main/basics/tx-lifecyclecosmos/sdk/latest/learn/concepts/lifecyclecosmos/main/build/architecture/adr-036-arbitrary-signaturecosmos/sdk/latest/reference/architecture/adr-036-arbitrary-signaturecosmos/main/build/modules/auth#gas--feescosmos/sdk/latest/modules/auth/auth#antehandlerscosmos/main/learn/beginner/gas-feescosmos/sdk/latest/learn/concepts/context-gas-eventscosmos/main/modules/auth#parameterscosmos/sdk/latest/modules/auth/auth#parameterscosmos/main/modules/authzcosmos/sdk/latest/modules/authz/READMEcosmos/main/modules/bankcosmos/sdk/latest/modules/bank/READMEcosmos/main/modules/crisiscosmos/sdk/latest/modules/crisis/READMEcosmos/main/modules/distributioncosmos/sdk/latest/modules/distribution/READMEcosmos/main/modules/govcosmos/sdk/latest/modules/gov/READMEcosmos/main/modules/mintcosmos/sdk/latest/modules/mint/READMEcosmos/main/modules/slashingcosmos/sdk/latest/modules/slashing/READMEcosmos/main/modules/stakingcosmos/sdk/latest/modules/staking/READMEcosmos/v0.45/modules/auth/03_antehandlers.htmlcosmos/sdk/latest/modules/auth/auth#antehandlerscosmos/main/learn/advanced/baseapp#antehandlercosmos/sdk/latest/learn/concepts/baseapp#antehandlercosmos/main/learn/advanced/baseapp#msg-service-routercosmos/sdk/latest/learn/concepts/baseapp#message-routingcosmos/main/learn/beginner/tx-lifecycle#antehandlercosmos/sdk/latest/learn/concepts/lifecycle#step-1-antehandlercosmos/main/modules/feegrantcosmos/sdk/latest/modules/feegrant/READMEcosmos/main/run-node/run-node#adding-genesis-accountscosmos/sdk/latest/node/run-node#3-add-genesis-accountscosmos/master/basics/gas-fees.html#antehandlercosmos/sdk/latest/learn/concepts/context-gas-eventscosmos/master/core/baseapp.html#runtxcosmos/sdk/latest/learn/concepts/baseapp#the-transaction-execution-pipelinecosmos/master/run-node/txs.html#broadcasting-a-transactioncosmos/sdk/latest/node/txs#broadcasting-a-transactiontendermint/v0.35/spec/abci/apps.html#consensus-connectioncosmos/cometbft/latest/spec/abci/Methodssdk-repo/blob/main/proto/cosmos/circuit/v1/tx.proto#L25-L75sdk-repo/blob/x/circuit/v0.1.0/proto/cosmos/circuit/v1/tx.proto#L25-L40sdk-repo/blob/main/proto/cosmos/circuit/v1/tx.proto#L77-L93sdk-repo/blob/x/circuit/v0.1.0/proto/cosmos/circuit/v1/tx.proto#L47-L60sdk-repo/blob/main/proto/cosmos/circuit/v1/tx.proto#L95-109sdk-repo/blob/x/circuit/v0.1.0/proto/cosmos/circuit/v1/tx.proto#L67-L78cosmos/main/learn/advanced/transactionscosmos/sdk/latest/learn/concepts/transactionscosmos/main/modules/auth/vesting/cosmos/sdk/latest/modules/auth/vestingcosmos/v0.50/build/modules/stakingcosmos/sdk/latest/modules/staking/README