Skip to content

docs: clean up broken callout, dead links, and outdated wording #1079

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
memosr wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −13
Open

docs: clean up broken callout, dead links, and outdated wording #1079

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/

9 changes: 0 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions reth/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand All @@ -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
Expand Down