docs: fix broken anchor line and stale org name in badge URLs#288
Open
memosr wants to merge 1 commit into
Open
docs: fix broken anchor line and stale org name in badge URLs#288memosr wants to merge 1 commit into
memosr wants to merge 1 commit into
Conversation
Two small documentation link fixes: 1. scripts/multiproof/README.md (line 11) — Update anchor link to MockDevTEEProverRegistry.addDevSigner() from #L22 to #L30. Line 22 lands inside the constructor body; the function is actually defined at line 30. 2. README.md — Update all 7 shield.io badge image URLs from base-org/contracts to base/contracts. The repo URL is github.com/base/contracts (confirmed by git remote) and the linked targets already point to the correct path, but the badge image URLs still query stats via the old base-org path.
Collaborator
🟡 Heimdall Review Status
|
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.
Summary
Two small documentation link fixes.
Changes
1.
scripts/multiproof/README.md(line 11) — Wrong anchor line numberThe link is supposed to point to the
addDevSigner()function definition. Line 22 lands inside the constructor body — the function is actually defined at line 30. Anyone clicking through to understand the dev signer bypass mechanism lands in the wrong place.2.
README.md— Stalebase-org/contractsin 7 shield.io badge URLsThe repo's actual path is
github.com/base/contracts(confirmed viagit remote -v), and the linked targets already point to the correct location. But all 7 badge image URLs still query stats via the oldbase-org/contractspath:Shields.io fetches stats from GitHub's API using the path provided. If GitHub's redirect doesn't transparently pass through to the API for stats endpoints, the badges either show stale numbers or fail silently.
Verification
30confirmed againsttest/mocks/MockDevTEEProverRegistry.sol