Skip to content

docs: fix broken anchor line and stale org name in badge URLs#288

Open
memosr wants to merge 1 commit into
base:mainfrom
memosr:fix/docs-links
Open

docs: fix broken anchor line and stale org name in badge URLs#288
memosr wants to merge 1 commit into
base:mainfrom
memosr:fix/docs-links

Conversation

@memosr
Copy link
Copy Markdown

@memosr memosr commented May 15, 2026

Summary

Two small documentation link fixes.

Changes

1. scripts/multiproof/README.md (line 11) — Wrong anchor line number

- [`MockDevTEEProverRegistry.addDevSigner()`](https://github.com/base/contracts/blob/main/test/mocks/MockDevTEEProverRegistry.sol#L22)
+ [`MockDevTEEProverRegistry.addDevSigner()`](https://github.com/base/contracts/blob/main/test/mocks/MockDevTEEProverRegistry.sol#L30)

The 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 — Stale base-org/contracts in 7 shield.io badge URLs

The repo's actual path is github.com/base/contracts (confirmed via git remote -v), and the linked targets already point to the correct location. But all 7 badge image URLs still query stats via the old base-org/contracts path:

- https://img.shields.io/github/contributors/base-org/contracts
- https://img.shields.io/github/commit-activity/w/base-org/contracts
- https://img.shields.io/github/stars/base-org/contracts.svg
- https://img.shields.io/github/repo-size/base-org/contracts
- https://img.shields.io/github/license/base-org/contracts?color=blue
- https://img.shields.io/github/issues-pr-raw/base-org/contracts
- https://img.shields.io/github/issues-raw/base-org/contracts.svg
+ https://img.shields.io/github/contributors/base/contracts
+ https://img.shields.io/github/commit-activity/w/base/contracts
+ https://img.shields.io/github/stars/base/contracts.svg
+ https://img.shields.io/github/repo-size/base/contracts
+ https://img.shields.io/github/license/base/contracts?color=blue
+ https://img.shields.io/github/issues-pr-raw/base/contracts
+ https://img.shields.io/github/issues-raw/base/contracts.svg

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

  • ✅ Only README files touched
  • ✅ Anchor line 30 confirmed against test/mocks/MockDevTEEProverRegistry.sol
  • ✅ All 7 badge URLs updated to current org path

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.
@cb-heimdall
Copy link
Copy Markdown
Collaborator

🟡 Heimdall Review Status

Requirement Status More Info
Reviews 🟡 0/1
Denominator calculation
Show calculation
1 if user is bot 0
1 if user is external 0
2 if repo is sensitive 0
From .codeflow.yml 1
Additional review requirements
Show calculation
Max 0
0
From CODEOWNERS 0
Global minimum 0
Max 1
1
1 if commit is unverified 1
Sum 2

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.

2 participants