From 2460d5b40d8aec60fd3157f19297d8e2bfecbac1 Mon Sep 17 00:00:00 2001 From: memosr Date: Thu, 14 May 2026 22:26:20 +0300 Subject: [PATCH] docs: clean up broken callout, dead links, and outdated wording MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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. --- CONTRIBUTING.md | 2 +- README.md | 9 --------- SECURITY.md | 2 +- reth/README.md | 4 ++-- 4 files changed, 4 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 59b2b6c8c..2c2ff1a95 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -52,5 +52,5 @@ All support requests must be made via [our support team][3]. [1]: https://github.com/base/node/issues [2]: https://medium.com/brigade-engineering/the-secrets-to-great-commit-messages-106fc0a92a25 -[3]: https://support.coinbase.com/customer/en/portal/articles/2288496-how-can-i-contact-coinbase-support- +[3]: https://help.coinbase.com/ diff --git a/README.md b/README.md index 1cbaad17d..ade9fca96 100644 --- a/README.md +++ b/README.md @@ -70,15 +70,6 @@ The following are the hardware specifications we use in production: - **Storage**: RAID 0 of all local NVMe drives (`/dev/nvme*`) - **Filesystem**: ext4 -> [!NOTE] -To run the node using a supported client, you can use the following command: -`CLIENT=supported_client docker compose up --build` - -Supported clients: - - reth (runs vanilla node by default, Flashblocks mode enabled by providing RETH_FB_WEBSOCKET_URL, see [Reth Node README](./reth/README.md)) - - geth - - nethermind - ## Configuration ### Required Settings diff --git a/SECURITY.md b/SECURITY.md index 01c472c39..c688d2678 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -31,7 +31,7 @@ program, view our [security program policies][7]. [2]: https://hackerone.com/coinbase?type=team [3]: https://docs.optimism.io/ [4]: https://immunefi.com/bounty/optimism/ -[5]: https://docs.optimism.io/docs/releases/bedrock/ +[5]: https://docs.optimism.io/stack/getting-started [6]: https://hackerone.com/coinbase [7]: https://hackerone.com/coinbase?view_policy=true diff --git a/reth/README.md b/reth/README.md index 485a0458a..c24abd917 100644 --- a/reth/README.md +++ b/reth/README.md @@ -4,7 +4,7 @@ This is an implementation of the Reth node setup that supports Flashblocks mode ## Setup -- See hardware requirements mentioned in the master README +- See hardware requirements in the root README - For Flashblocks mode: Access to a Flashblocks websocket endpoint (for `RETH_FB_WEBSOCKET_URL`) - We provide public websocket endpoints for mainnet and devnet, included in `.env.mainnet` and `.env.sepolia` @@ -17,7 +17,7 @@ The node determines its mode based on the presence of the `RETH_FB_WEBSOCKET_URL ## Running the Node -The node follows the standard `docker compose` workflow in the master README. +The node follows the standard `docker compose` workflow in the root README. ```bash # To run Reth node with Flashblocks support, set RETH_FB_WEBSOCKET_URL in your .env file