Repair upstream GitHub references for SDK v0.55 and CometBFT v0.40 - #337
Open
evanorti wants to merge 1 commit into
Open
Repair upstream GitHub references for SDK v0.55 and CometBFT v0.40#337evanorti wants to merge 1 commit into
evanorti wants to merge 1 commit into
Conversation
Correct 160 links so every upstream reference resolves and points at the code the surrounding prose describes. SDK now has 250 of 313 links in latest/ on release/v0.55.x, CometBFT 105 of 109 on v0.40.x. The remainder is deliberate: ADRs cite code as it stood at decision time, and version-specific upgrade and changelog pages keep their own version's refs. Nine factual corrections came out of checking prose against the code it links to. The most consequential is on enterprise/poa/distribution.mdx, which called enabling the PoA module account "recommended" with a fee_collector fallback; EndBlocker panics at block 1 otherwise. Unlink six dead third-party URLs whose repositories moved with no successor, leaving the URLs visible as inline code. Add check-github-refs.js and verify-links-live.js with 40 fixture tests, plus the update-stale-refs and pr-description skills. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Contributor
|
Too many files changed for review. ( Bypass the limit by tagging |
This comment was marked as spam.
This comment was marked as spam.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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
2 participants
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.
Summary
Repairs every upstream GitHub reference in the SDK and CometBFT docs after the v0.55 and v0.40 freeze, and adds tooling so the next release is a script run.
Resubmission of the work reverted in #336, which reached
mainwithout review. The content is unchanged and the tree is identical to what was verified there.Changes
latest/now onrelease/v0.55.x, CometBFT 105 of 109 onv0.40.x. The remainder is deliberate: ADRs cite code as it stood at decision time, and version-specific upgrade and changelog pages keep their own version's refs.check-github-refs.jsandverify-links-live.jswith 40 fixture tests, plus theupdate-stale-refsandpr-descriptionskills.Review focus
enterprise/poa/distribution.mdxdescribed enabling the PoA module account as "recommended" with afee_collectorfallback.EndBlockerpanics at block 1 otherwise, so a chain following that page would have halted on its first block. Three other PoA claims were wrong in the same direction.Most line ranges rest on the re-derivation method rather than individual confirmation. All 91 changed pages were reviewed by agents that did not make the changes, which caught one anchor bumped away from the version its own sentence names.
Verification
459 unique URLs all resolve with no anchor past end of file;
mint broken-linksclean; CometBFTlatest/nextparity 0; 40/40 fixture tests. Detail inwork-log/gh-links-2.md.Note: SDK
latest/nextparity shows 4 diverged files (security/bug-bounty.mdx,security-policy.mdx,audits.mdx,learn/concepts/modules.mdx). All four are already diverged onmainand none is touched by this PR.🤖 Generated with Claude Code