docs: clean up broken callout, dead links, and outdated wording#1079
Open
memosr wants to merge 1 commit into
Open
docs: clean up broken callout, dead links, and outdated wording#1079memosr wants to merge 1 commit into
memosr wants to merge 1 commit into
Conversation
Four small documentation fixes: 1. README.md — Remove broken [!NOTE] callout block. The lines after the callout marker did not start with > prefix, so the callout rendered incorrectly. The information was already duplicated in the Quick Start and Supported Clients sections immediately above. 2. reth/README.md — Replace master README with root README on lines 7 and 20. The new term is unambiguous and matches modern open source conventions. 3. CONTRIBUTING.md — Update deprecated Coinbase support URL. The old /customer/en/portal/articles/ format has been retired. Updated to current https://help.coinbase.com/. 4. SECURITY.md — Update dead OP Stack docs link. /docs/releases/bedrock/ no longer exists. Updated to current /stack/getting-started 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
Four small but real documentation fixes across the repo.
Changes
1.
README.md— Remove broken[!NOTE]callout blockThe callout marker
> [!NOTE]was followed by lines that did not start with the>prefix, breaking the GitHub callout syntax:The same information is already present in the Quick Start (lines 34-38) and Supported Clients (lines 41-45) sections immediately above, so the redundant block was removed entirely.
2.
reth/README.md— Replace "master README" with "root README""master" as a hierarchy term is ambiguous — readers might wonder if it refers to a branch name. "root README" is unambiguous and matches modern open source conventions.
3.
CONTRIBUTING.md— Update deprecated Coinbase support URLThe old Zendesk-style
/customer/en/portal/articles/URL format has been retired. The modern entry point ishelp.coinbase.com.4.
SECURITY.md— Update dead OP Stack docs linkThe
/docs/releases/bedrock/path no longer exists in the current OP Stack documentation. Updated to the current canonical path.Verification