doc: execution layer sync for alternative clients #790
Conversation
WalkthroughThese changes introduce a new configuration option Changes
Recent review detailsConfiguration used: .coderabbit.yaml Files selected for processing (5)
Files skipped from review due to trivial changes (1)
Additional context usedPath-based instructions (3)
LanguageTool
Additional comments not posted (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (5)
pages/builders/node-operators/management/snap-sync.mdx (3)
84-101: Ensure Consistency in TerminologyThe term "execution-layer syncing" should be consistent throughout the documentation. Consider using "execution layer sync" without the hyphen for consistency.
- In addition to op-geth, you can enable execution-layer syncing with alternative execution clients such as `reth` and `op-erigon`. + In addition to op-geth, you can enable execution layer sync with alternative execution clients such as `reth` and `op-erigon`.
87-88: Clarify the Design and RequirementsThe sentence "Unlike
op-geth,rethandop-erigonare designed as archive nodes..." could be clearer about the requirements for these clients.- Unlike `op-geth`, `reth` and `op-erigon` are designed as archive nodes, which means they require the complete history of the chain. + Unlike `op-geth`, `reth` and `op-erigon` are designed as archive nodes, meaning they require the complete history of the chain.
98-101: Improve Readability of Code Block CommentsThe comments in the code block should be more descriptive for better readability.
- # for reth + # Enable execution layer sync for reth - # for erigon + # Enable execution layer sync for erigonpages/builders/node-operators/configuration/base-config.mdx (1)
162-163: Ensure Consistency in Configuration OptionsThe configuration options should be consistent with the rest of the documentation. Ensure the correct usage of the
--syncmodeand--l2.enginekindflags.- --syncmode=execution-layer \ - --l2.enginekind=geth + --syncmode=execution-layer \\ + --l2.enginekind=gethpages/builders/node-operators/configuration/consensus-config.mdx (1)
232-240: Avoid Repetition in DocumentationThe repetition of the word "engine" in successive sentences can be avoided for better readability.
- The kind of engine client, used to control the behavior of optimism in respect to different types of engine clients. Valid options: `geth`, `reth`, `erigon`. The default value is `geth`. + The kind of engine client used to control the behavior of optimism in respect to different types of clients. Valid options: `geth`, `reth`, `erigon`. The default value is `geth`.Tools
LanguageTool
[style] ~238-~238: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ... <Tabs.Tab>--l2.enginekind=geth</Tabs.Tab> <Tabs.Tab>`OP_NODE_L2_ENGINE_KIND=ge...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Description
A new
l2.enginekindflag was added for op-node recently: ethereum-optimism/optimism#10767.Setting this to the relevant engine client kind allows users to use snap sync (or execution-layer syncing to be more exact) on alternative clients like op-erigon and reth.
This PR adds a section about using this flag in the
Using Snap Sync for Node Operatorsdocs. It also adds usage ofl2.enginekindto various places in the docs so that users can notice this flag more.If you find other documentation that is more relevant for this change, please let me know! 😄
Tests
All changes are formatted and linted via pnpm.
Additional context
N/A
Metadata
N/A