3 new node pages #679
3 new node pages #679
Conversation
part 1 of node revision: - new base config page - new node architecture page
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
- split config page into 2 pages (op-node config + op-geth config) - update redirects file - update links pointing to old config page - update side-nav, new config folder in side nav
|
Warning Rate Limit Exceeded@cpengilly has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 3 minutes and 30 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. WalkthroughThe updates primarily involve refining and reorganizing the configuration documentation for node operators. Key changes include updating hyperlinks to point to new locations, adding new configuration files, and adjusting JSON metadata to reflect these changes. Additionally, a new file detailing node architecture has been introduced, and several links have been updated to ensure accuracy. The changes aim to improve the clarity and accessibility of the configuration and management documentation for node operators. Changes
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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 16
Out of diff range and nitpick comments (29)
pages/builders/chain-operators/management/snap-sync.mdx (2)
Line range hint
6-24: Review the repetitive sentence structure in the introduction to improve readability.Consider rephrasing to vary the sentence beginnings and improve the flow of the text.
26-27: Update the hyperlink format to ensure consistency across the documentation.Consider using a consistent style for all hyperlinks to enhance the user experience and maintain consistency.
pages/builders/node-operators/overview.mdx (1)
Line range hint
6-24: Review the use of personal pronouns and ensure consistency with the documentation style guide.Consider replacing personal pronouns like 'we' with the organization's name or a neutral term to maintain a professional tone in the documentation.
pages/builders/node-operators/management/snap-sync.mdx (3)
Line range hint
6-24: Review the repetitive sentence structure in the introduction to improve readability.Consider rephrasing to vary the sentence beginnings and improve the flow of the text.
26-27: Update the hyperlink format to ensure consistency across the documentation.Consider using a consistent style for all hyperlinks to enhance the user experience and maintain consistency.
Line range hint
35-35: Clarify the instruction on disabling transaction gossip.The flag
--rollup.disabletxpoolgossipis mentioned but not explained. Consider adding a brief explanation or a link to more detailed information.pages/builders/node-operators/architecture.mdx (1)
6-24: Review the use of personal pronouns and ensure consistency with the documentation style guide.Consider replacing personal pronouns like 'we' with the organization's name or a neutral term to maintain a professional tone in the documentation.
public/_redirects (1)
[!TIP]
Codebase VerificationSeveral files in the codebase still use the old function signature.
- The directories specified in the redirect rules do not exist in the repository. This suggests that the redirect rules may be outdated or incorrect.
- It is recommended to review and update the redirect rules to reflect the current repository structure or to ensure that the intended destinations are correct.
Analysis chain
Line range hint
1-69: Verify the accuracy and necessity of each redirect rule.
---Scripts Executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the accuracy and necessity of redirect rules. # Test: Cross-reference redirect rules with documentation to ensure they are necessary and accurate. rg --type txt -f public/_redirects --files-with-matchesLength of output: 57
Script:
#!/bin/bash # List all text files in the repository to check for the presence of documentation files fd --type f --extension txtLength of output: 39
Script:
#!/bin/bash # Check the existence of a few sample paths from the redirect rules fd --type d --full-path '/builders/tools/rpc-providers' fd --type d --full-path '/builders/tools/connect/rpc-providers' fd --type d --full-path '/builders/tools/block-explorers' fd --type d --full-path '/builders/tools/build/block-explorers' fd --type d --full-path '/builders/tools/faucets' fd --type d --full-path '/builders/tools/build/faucets'Length of output: 347
pages/builders/chain-operators/management/operations.mdx (2)
Line range hint
6-24: Review the use of personal pronouns and ensure consistency with the documentation style guide.Consider replacing personal pronouns like 'we' with the organization's name or a neutral term to maintain a professional tone in the documentation.
Line range hint
116-116: Clarify the instruction on checking flags.The section on checking flags is mentioned but not explained. Consider adding a brief explanation or a link to more detailed information.
pages/builders/node-operators/configuration/base-config.mdx (1)
6-24: Review the use of personal pronouns and ensure consistency with the documentation style guide.Consider replacing personal pronouns like 'we' with the organization's name or a neutral term to maintain a professional tone in the documentation.
pages/builders/chain-operators/tutorials/create-l2-rollup.mdx (18)
Line range hint
21-22: Consider revising the phrasing to enhance clarity and conciseness.- This tutorial is **designed for developers** who want to learn about the OP Stack by spinning up an OP Stack testnet chain. - You'll walk through the full deployment process and teach you all of the components that make up the OP Stack, and **you'll end up with your very own OP Stack testnet**. + This tutorial, designed for developers, guides you through setting up an OP Stack testnet chain. It covers the full deployment process, explaining each component of the OP Stack, culminating in your own OP Stack testnet.
Line range hint
25-25: Use a hyphen for the compound adjective "open-source."- **The OP Stack is free and open source software licensed entirely under the MIT license**. + **The OP Stack is free and open-source software licensed entirely under the MIT license**.
Line range hint
63-63: Add a comma after "tutorial" for better readability.- In this tutorial you'll be using the [`op-node` implementation](https://github.com/ethereum-optimism/optimism/tree/v1.1.4/op-node) found within the [Optimism Monorepo](https://github.com/ethereum-optimism/optimism). + In this tutorial, you'll be using the [`op-node` implementation](https://github.com/ethereum-optimism/optimism/tree/v1.1.4/op-node) found within the [Optimism Monorepo](https://github.com/ethereum-optimism/optimism).
Line range hint
70-70: Add a comma after "tutorial" for better readability.- In this tutorial you'll be using the [`op-geth` implementation](https://github.com/ethereum-optimism/op-geth) found within the [`op-geth` repository](https://github.com/ethereum-optimism/op-geth). + In this tutorial, you'll be using the [`op-geth` implementation](https://github.com/ethereum-optimism/op-geth) found within the [`op-geth` repository](https://github.com/ethereum-optimism/op-geth).
Line range hint
82-82: Add a comma after "future" for better readability.- The Proposer will be removed in the future but for now it's a necessary component of the OP Stack. + The Proposer will be removed in the future, but for now, it's a necessary component of the OP Stack.
Line range hint
138-138: Add a comma after "code" for better readability.- You're going to be spinning up your OP Stack chain directly from source code instead of using a container system like [Docker](https://www.docker.com/). + You're going to be spinning up your OP Stack chain directly from source code, instead of using a container system like [Docker](https://www.docker.com/).
Line range hint
183-183: Consider removing "of" to be more concise.- Run the following script and double check that you have all of the required versions installed. + Run the following script and double check that you have all the required versions installed.
Line range hint
196-196: This phrase is redundant. Consider using "inside."- Build the various packages inside of the Optimism Monorepo + Build the various packages inside the Optimism Monorepo
Line range hint
263-263: Simplify the phrasing for clarity.- The `Admin` address has the ability to upgrade contracts. + The `Admin` address can upgrade contracts.
Line range hint
319-319: Add a comma after "address" for better readability.- You do not need to send any ETH to the `Sequencer` address as it does not send transactions. + You do not need to send any ETH to the `Sequencer` address, as it does not send transactions.
Line range hint
376-376: This phrase is redundant. Consider using "inside."- Currently, chain configuration lives inside of the [`contracts-bedrock`](https://github.com/ethereum-optimism/optimism/tree/v1.1.4/packages/contracts-bedrock) package in the form of a JSON file. + Currently, chain configuration lives inside the [`contracts-bedrock`](https://github.com/ethereum-optimism/optimism/tree/v1.1.4/packages/contracts-bedrock) package in the form of a JSON file.
Line range hint
394-394: This phrase is redundant. Consider using "inside."- Run the following script to generate the `getting-started.json` configuration file inside of the `deploy-config` directory. + Run the following script to generate the `getting-started.json` configuration file inside the `deploy-config` directory.
Line range hint
429-429: Use a comma before 'and' if it connects two independent clauses.- If the command returns `69` then the contract has been deployed and you can safely skip this section. + If the command returns `69`, then the contract has been deployed, and you can safely skip this section.
Line range hint
488-488: Add a comma after "contracts" for better readability.- Now that you've set up the L1 smart contracts you can automatically generate several configuration files that are used within the Consensus Client and the Execution Client. + Now that you've set up the L1 smart contracts, you can automatically generate several configuration files that are used within the Consensus Client and the Execution Client.
Line range hint
542-542: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.- You're going to be running a Sequencer node, so you'll need to import the `Sequencer` private key that you generated earlier. + As you're setting up a Sequencer node, import the `Sequencer` private key that you generated earlier.
Line range hint
625-625: Add a comma after "running" for better readability.- Once you've got `op-geth` running you'll need to run `op-node`. + Once you've got `op-geth` running, you'll need to run `op-node`.
Line range hint
662-662: This phrase is redundant. Consider using "inside."- You'll start to see blocks being created inside of `op-geth`. + You'll start to see blocks being created inside `op-geth`.
Line range hint
692-692: Consider using an alternative to "a lot of" to enhance the writing.- it can expend ETH quickly if there are a lot of transactions to publish. + it can expend ETH quickly if there are many transactions to publish.
There was a problem hiding this comment.
Actionable comments posted: 7
Out of diff range and nitpick comments (72)
pages/builders/chain-operators/tutorials/create-l2-rollup.mdx (11)
Line range hint
21-22: Consider using more assertive language to enhance the tutorial's tone.- This tutorial is **designed for developers** who want to learn about the OP Stack by spinning up an OP Stack testnet chain. + This tutorial **guides developers** through the process of learning about the OP Stack by setting up an OP Stack testnet chain.
Line range hint
25-25: Use a hyphen for compound adjectives before nouns for clarity.- **The OP Stack is free and open source software licensed entirely under the MIT license**. + **The OP Stack is free and open-source software licensed entirely under the MIT license**.
Line range hint
63-63: Add a comma after "tutorial" for grammatical correctness.- In this tutorial you'll be using the [`op-node` implementation](https://github.com/ethereum-optimism/optimism/tree/v1.1.4/op-node) found within the [Optimism Monorepo](https://github.com/ethereum-optimism/optimism). + In this tutorial, you'll be using the [`op-node` implementation](https://github.com/ethereum-optimism/optimism/tree/v1.1.4/op-node) found within the [Optimism Monorepo](https://github.com/ethereum-optimism/optimism).
Line range hint
70-70: Add a comma after "tutorial" for grammatical correctness.- In this tutorial you'll be using the [`op-geth` implementation](https://github.com/ethereum-optimism/op-geth) found within the [`op-geth` repository](https://github.com/ethereum-optimism/op-geth). + In this tutorial, you'll be using the [`op-geth` implementation](https://github.com/ethereum-optimism/op-geth) found within the [`op-geth` repository](https://github.com/ethereum-optimism/op-geth).
Line range hint
82-82: Add a comma after "future" for grammatical correctness.- The Proposer will be removed in the future but for now it's a necessary component of the OP Stack. + The Proposer will be removed in the future, but for now, it's a necessary component of the OP Stack.
Line range hint
183-183: Consider removing "of" to be more concise.- double check that you have all of the required versions installed. + double check that you have all the required versions installed.
Line range hint
196-196: Use "inside" instead of "inside of" for conciseness.- Build the various packages inside of the Optimism Monorepo + Build the various packages inside the Optimism Monorepo
Line range hint
347-347: Add a comma after "Next" for grammatical correctness.- Next you'll need to allow `direnv` to read this file and load the variables into your terminal using the following command. + Next, you'll need to allow `direnv` to read this file and load the variables into your terminal using the following command.
Line range hint
376-376: Use "inside" instead of "inside of" for conciseness.- Currently, chain configuration lives inside of the [`contracts-bedrock`](https://github.com/ethereum-optimism/optimism/tree/v1.1.4/packages/contracts-bedrock) package in the form of a JSON file. + Currently, chain configuration lives inside the [`contracts-bedrock`](https://github.com/ethereum-optimism/optimism/tree/v1.1.4/packages/contracts-bedrock) package in the form of a JSON file.
Line range hint
394-394: Use "inside" instead of "inside of" for conciseness.- Generate the `getting-started.json` configuration file inside of the `deploy-config` directory. + Generate the `getting-started.json` configuration file inside the `deploy-config` directory.
Line range hint
662-662: Use "inside" instead of "inside of" for conciseness.- you'll start to see blocks being created inside of `op-geth`. + you'll start to see blocks being created inside `op-geth`.pages/builders/node-operators/configuration/node-config.mdx (60)
22-30: Consider varying the sentence structure to enhance readability.In the examples provided for
conductor.enabled, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
32-40: Consider varying the sentence structure to enhance readability.In the examples provided for
conductor.rpc, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
42-50: Consider varying the sentence structure to enhance readability.In the examples provided for
conductor.rpc-timeout value, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
52-60: Consider varying the sentence structure to enhance readability.In the examples provided for
heartbeat.enabled, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
62-70: Consider varying the sentence structure to enhance readability.In the examples provided for
heartbeat.moniker, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
72-80: Consider varying the sentence structure to enhance readability.In the examples provided for
heartbeat.url, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
82-90: Consider varying the sentence structure to enhance readability.In the examples provided for
l1, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
92-100: Consider varying the sentence structure to enhance readability.In the examples provided for
l1.beacon, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
102-110: Consider varying the sentence structure to enhance readability.In the examples provided for
l1.beacon.fetch-all-sidecars, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
112-120: Consider varying the sentence structure to enhance readability.In the examples provided for
l1.beacon.ignore, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
122-130: Consider varying the sentence structure to enhance readability.In the examples provided for
l1.epoch-poll-interval, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
132-140: Consider varying the sentence structure to enhance readability.In the examples provided for
l1.http-poll-interval, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
142-150: Consider varying the sentence structure to enhance readability.In the examples provided for
l1.max-concurrency, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
152-160: Consider varying the sentence structure to enhance readability.In the examples provided for
l1.rpc-max-batch-size, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
162-170: Consider varying the sentence structure to enhance readability.In the examples provided for
l1.rpc-rate-limit, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
172-180: Consider varying the sentence structure to enhance readability.In the examples provided for
l1.rpckind, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
186-194: Consider varying the sentence structure to enhance readability.In the examples provided for
l1.runtime-config-reload-interval, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
206-210: Consider varying the sentence structure to enhance readability.In the examples provided for
l1.trustrpc, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
216-220: Consider varying the sentence structure to enhance readability.In the examples provided for
l2, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
226-230: Consider varying the sentence structure to enhance readability.In the examples provided for
l2.jwt-secret, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
232-240: Consider varying the sentence structure to enhance readability.In the examples provided for
log.color, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
242-250: Consider varying the sentence structure to enhance readability.In the examples provided for
log.format, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
252-260: Consider varying the sentence structure to enhance readability.In the examples provided for
log.level, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
262-270: Consider varying the sentence structure to enhance readability.In the examples provided for
metrics.addr, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
272-280: Consider varying the sentence structure to enhance readability.In the examples provided for
metrics.enabled, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
282-290: Consider varying the sentence structure to enhance readability.In the examples provided for
metrics.port, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
292-305: Consider varying the sentence structure to enhance readability.In the examples provided for
network, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
307-315: Consider varying the sentence structure to enhance readability.In the examples provided for
override.canyon, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
317-325: Consider varying the sentence structure to enhance readability.In the examples provided for
override.delta, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
327-335: Consider varying the sentence structure to enhance readability.In the examples provided for
override.ecotone, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
337-345: Consider varying the sentence structure to enhance readability.In the examples provided for
p2p.advertise.ip, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
347-355: Consider varying the sentence structure to enhance readability.In the examples provided for
p2p.advertise.tcp, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
357-365: Consider varying the sentence structure to enhance readability.In the examples provided for
p2p.advertise.udp, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
367-375: Consider varying the sentence structure to enhance readability.In the examples provided for
p2p.ban.duration, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
377-385: Consider varying the sentence structure to enhance readability.In the examples provided for
p2p.ban.peers, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
387-395: Consider varying the sentence structure to enhance readability.In the examples provided for
p2p.ban.threshold, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
397-405: Consider varying the sentence structure to enhance readability.In the examples provided for
p2p.bootnodes, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
407-415: Consider varying the sentence structure to enhance readability.In the examples provided for
p2p.disable, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
417-425: Consider varying the sentence structure to enhance readability.In the examples provided for
p2p.discovery.path, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
427-435: Consider varying the sentence structure to enhance readability.In the examples provided for
p2p.listen.ip, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
437-445: Consider varying the sentence structure to enhance readability.In the examples provided for
p2p.listen.tcp, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
447-455: Consider varying the sentence structure to enhance readability.In the examples provided for
p2p.listen.udp, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
457-465: Consider varying the sentence structure to enhance readability.In the examples provided for
p2p.nat, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
467-475: Consider varying the sentence structure to enhance readability.In the examples provided for
p2p.netrestrict, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
477-485: Consider varying the sentence structure to enhance readability.In the examples provided for
p2p.no-discovery, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
487-495: Consider varying the sentence structure to enhance readability.In the examples provided for
p2p.peers.grace, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
497-505: Consider varying the sentence structure to enhance readability.In the examples provided for
p2p.peers.hi, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
507-515: Consider varying the sentence structure to enhance readability.In the examples provided for
p2p.peers.lo, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
517-525: Consider varying the sentence structure to enhance readability.In the examples provided for
p2p.peerstore.path, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
527-535: Consider varying the sentence structure to enhance readability.In the examples provided for
p2p.priv.path, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
537-545: Consider varying the sentence structure to enhance readability.In the examples provided for
p2p.scoring, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
547-555: Consider varying the sentence structure to enhance readability.In the examples provided for
p2p.sequencer.key, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
557-568: Consider varying the sentence structure to enhance readability.In the examples provided for
p2p.static, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
570-578: Consider varying the sentence structure to enhance readability.In the examples provided for
p2p.sync.req-resp, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
580-588: Consider varying the sentence structure to enhance readability.In the examples provided for
pprof.addr, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
590-598: Consider varying the sentence structure to enhance readability.In the examples provided for
pprof.enabled, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
600-608: Consider varying the sentence structure to enhance readability.In the examples provided for
pprof.path, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
610-618: Consider varying the sentence structure to enhance readability.In the examples provided for
pprof.port, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
620-628: Consider varying the sentence structure to enhance readability.In the examples provided for
pprof.type, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.
630-638: Consider varying the sentence structure to enhance readability.In the examples provided for
rollup.config, consider rephrasing to avoid repetitive sentence beginnings. This can enhance the readability and flow of the documentation.pages/builders/node-operators/configuration/geth-config.mdx (1)
Line range hint
603-603: Clarify the use of hyphens in compound modifiers.- Select a pre-configured OP-Stack network (warning: op-mainnet and op-goerli require special sync, datadir is recommended), options: + Select a pre-configured OP-Stack network (warning: op-mainnet and op-goerli require special sync, datadir is recommended), options:
There was a problem hiding this comment.
Actionable comments posted: 0
Out of diff range and nitpick comments (31)
pages/builders/chain-operators/tutorials/create-l2-rollup.mdx (31)
Line range hint
21-21: Consider using "intended" instead of "designed" to strengthen your wording.- This tutorial is **designed for developers** who want to learn about the OP Stack by spinning up an OP Stack testnet chain. + This tutorial is **intended for developers** who want to learn about the OP Stack by spinning up an OP Stack testnet chain.
Line range hint
22-22: Remove "of" to be more concise.- You'll walk through the full deployment process and teach you all of the components that make up the OP Stack, and **you'll end up with your very own OP Stack testnet**. + You'll walk through the full deployment process and teach you all the components that make up the OP Stack, and **you'll end up with your very own OP Stack testnet**.
Line range hint
25-25: Consider hyphenating "open source" as it is a compound adjective modifying "software."- **The OP Stack is free and open source software licensed entirely under the MIT license**. + **The OP Stack is free and open-source software licensed entirely under the MIT license**.
Line range hint
63-63: Add a comma after "OptimismJ" for clarity.- [`hildr`](https://github.com/optimism-java/hildr) (maintained by OptimismJ). In this tutorial you'll be using the [`op-node` implementation](https://github.com/ethereum-optimism/optimism/tree/v1.1.4/op-node) found within the [Optimism Monorepo](https://github.com/ethereum-optimism/optimism). + [`hildr`](https://github.com/optimism-java/hildr) (maintained by OptimismJ). In this tutorial, you'll be using the [`op-node` implementation](https://github.com/ethereum-optimism/optimism/tree/v1.1.4/op-node) found within the [Optimism Monorepo](https://github.com/ethereum-optimism/optimism).
Line range hint
70-70: Add a comma after "coming soon" for clarity.- `op-nethermind` (coming soon). In this tutorial you'll be using the [`op-geth` implementation](https://github.com/ethereum-optimism/op-geth) found within the [`op-geth` repository](https://github.com/ethereum-optimism/op-geth). + `op-nethermind` (coming soon). In this tutorial, you'll be using the [`op-geth` implementation](https://github.com/ethereum-optimism/op-geth) found within the [`op-geth` repository](https://github.com/ethereum-optimism/op-geth).
Line range hint
75-75: Consider using "regularly" instead of "on a regular basis" to be more concise.- The Batcher runs continuously alongside the Sequencer and publishes transactions in batches (hence the name) on a regular basis. + The Batcher runs continuously alongside the Sequencer and publishes transactions in batches (hence the name) regularly.
Line range hint
82-82: Add a comma after "future" for clarity.- It's likely that the Proposer will be removed in the future, but for now it's a necessary component of the OP Stack. + It's likely that the Proposer will be removed in the future, but for now, it's a necessary component of the OP Stack.
Line range hint
138-138: Add a comma after "source code" for clarity.- You're going to be spinning up your OP Stack chain directly from source code instead of using a container system like [Docker](https://www.docker.com/). + You're going to be spinning up your OP Stack chain directly from source code, instead of using a container system like [Docker](https://www.docker.com/).
Line range hint
183-183: Remove "of" to be more concise.- Run the following script and double check that you have all of the required versions installed. + Run the following script and double check that you have all the required versions installed.
Line range hint
196-196: Consider using "inside" instead of "inside of" to be more concise.- {<h3>Build the various packages inside of the Optimism Monorepo</h3>} + {<h3>Build the various packages inside the Optimism Monorepo</h3>}
Line range hint
263-263: Consider using "can" instead of "has the ability to" for conciseness.- The `Admin` address has the ability to upgrade contracts. + The `Admin` address can upgrade contracts.
Line range hint
319-319: Add a comma after "address" for clarity.- You do not need to send any ETH to the `Sequencer` address as it does not send transactions. + You do not need to send any ETH to the `Sequencer` address, as it does not send transactions.
Line range hint
376-376: Consider using "inside" instead of "inside of" to be more concise.- Currently, chain configuration lives inside of the [`contracts-bedrock`](https://github.com/ethereum-optimism/optimism/tree/v1.1.4/packages/contracts-bedrock) package in the form of a JSON file. + Currently, chain configuration lives inside the [`contracts-bedrock`](https://github.com/ethereum-optimism/optimism/tree/v1.1.4/packages/contracts-bedrock) package in the form of a JSON file.
Line range hint
394-394: Consider using "inside" instead of "inside of" to be more concise.- Run the following script to generate the `getting-started.json` configuration file inside of the `deploy-config` directory. + Run the following script to generate the `getting-started.json` configuration file inside the `deploy-config` directory.
Line range hint
429-429: Use a comma before "and" to connect two independent clauses.- If the command returns `69` then the contract has been deployed and you can safely skip this section. + If the command returns `69`, then the contract has been deployed, and you can safely skip this section.
Line range hint
542-542: Consider replacing "you'll need to" with "you must" for variety and emphasis.- You're going to be running a Sequencer node, so you'll need to import the `Sequencer` private key that you generated earlier. + You're going to be running a Sequencer node, so you must import the `Sequencer` private key that you generated earlier.
Line range hint
625-625: Add a comma after "running" for clarity.- Once you've got `op-geth` running you'll need to run `op-node`. + Once you've got `op-geth` running, you'll need to run `op-node`.
Line range hint
662-662: Consider using "inside" instead of "inside of" to be more concise.- you'll start to see blocks being created inside of `op-geth`. + you'll start to see blocks being created inside `op-geth`.
Line range hint
692-692: Consider using "many" instead of "a lot of" for conciseness.- it can expend ETH quickly if there are a lot of transactions to publish. + it can expend ETH quickly if there are many transactions to publish.
Line range hint
63-63: Add a comma after "OptimismJ" for clarity.- [`hildr`](https://github.com/optimism-java/hildr) (maintained by OptimismJ). In this tutorial you'll be using the [`op-node` implementation](https://github.com/ethereum-optimism/optimism/tree/v1.1.4/op-node) found within the [Optimism Monorepo](https://github.com/ethereum-optimism/optimism). + [`hildr`](https://github.com/optimism-java/hildr) (maintained by OptimismJ). In this tutorial, you'll be using the [`op-node` implementation](https://github.com/ethereum-optimism/optimism/tree/v1.1.4/op-node) found within the [Optimism Monorepo](https://github.com/ethereum-optimism/optimism).
Line range hint
70-70: Add a comma after "coming soon" for clarity.- `op-nethermind` (coming soon). In this tutorial you'll be using the [`op-geth` implementation](https://github.com/ethereum-optimism/op-geth) found within the [`op-geth` repository](https://github.com/ethereum-optimism/op-geth). + `op-nethermind` (coming soon). In this tutorial, you'll be using the [`op-geth` implementation](https://github.com/ethereum-optimism/op-geth) found within the [`op-geth` repository](https://github.com/ethereum-optimism/op-geth).
Line range hint
75-75: Consider using "regularly" instead of "on a regular basis" to be more concise.- The Batcher runs continuously alongside the Sequencer and publishes transactions in batches (hence the name) on a regular basis. + The Batcher runs continuously alongside the Sequencer and publishes transactions in batches (hence the name) regularly.
Line range hint
82-82: Add a comma after "future" for clarity.- It's likely that the Proposer will be removed in the future, but for now it's a necessary component of the OP Stack. + It's likely that the Proposer will be removed in the future, but for now, it's a necessary component of the OP Stack.
Line range hint
138-138: Add a comma after "source code" for clarity.- You're going to be spinning up your OP Stack chain directly from source code instead of using a container system like [Docker](https://www.docker.com/). + You're going to be spinning up your OP Stack chain directly from source code, instead of using a container system like [Docker](https://www.docker.com/).
Line range hint
183-183: Remove "of" to be more concise.- Run the following script and double check that you have all of the required versions installed. + Run the following script and double check that you have all the required versions installed.
Line range hint
196-196: Consider using "inside" instead of "inside of" to be more concise.- {<h3>Build the various packages inside of the Optimism Monorepo</h3>} + {<h3>Build the various packages inside the Optimism Monorepo</h3>}
Line range hint
263-263: Consider using "can" instead of "has the ability to" for conciseness.- The `Admin` address has the ability to upgrade contracts. + The `Admin` address can upgrade contracts.
Line range hint
319-319: Add a comma after "address" for clarity.- You do not need to send any ETH to the `Sequencer` address as it does not send transactions. + You do not need to send any ETH to the `Sequencer` address, as it does not send transactions.
Line range hint
376-376: Consider using "inside" instead of "inside of" to be more concise.- Currently, chain configuration lives inside of the [`contracts-bedrock`](https://github.com/ethereum-optimism/optimism/tree/v1.1.4/packages/contracts-bedrock) package in the form of a JSON file. + Currently, chain configuration lives inside the [`contracts-bedrock`](https://github.com/ethereum-optimism/optimism/tree/v1.1.4/packages/contracts-bedrock) package in the form of a JSON file.
Line range hint
394-394: Consider using "inside" instead of "inside of" to be more concise.- Run the following script to generate the `getting-started.json` configuration file inside of the `deploy-config` directory. + Run the following script to generate the `getting-started.json` configuration file inside the `deploy-config` directory.
Line range hint
429-429: Use a comma before "and" to connect two independent clauses.- If the command returns `69` then the contract has been deployed and you can safely skip this section. + If the command returns `69`, then the contract has been deployed, and you can safely skip this section.
There was a problem hiding this comment.
Actionable comments posted: 22
Out of diff range and nitpick comments (37)
pages/builders/chain-operators/management/snap-sync.mdx (2)
Line range hint
14-14: Reword repetitive sentence structure.Three successive sentences begin with "Snap Sync." Consider rewording for better readability.
- Snap Sync significantly improves the experience of syncing an OP Stack node. Snap Sync is a native feature of go-ethereum that is now optionally enabled on `op-node` & `op-geth`. Snap Sync works by downloading a snapshot of the state from other nodes on the network and is then able to start executing blocks from the completed state rather than having to re-execute every single block. + Snap Sync significantly improves the experience of syncing an OP Stack node. This native feature of go-ethereum is now optionally enabled on `op-node` & `op-geth`. It works by downloading a snapshot of the state from other nodes on the network and can then start executing blocks from the completed state rather than having to re-execute every single block.
Line range hint
14-14: Use a shorter alternative for "able to."Consider using "can then" instead of "is then able to" for conciseness.
- and is then able to start executing blocks from the completed state rather than having to re-execute every single block. + and can then start executing blocks from the completed state rather than having to re-execute every single block.pages/builders/node-operators/management/snap-sync.mdx (2)
Line range hint
14-14: Reword repetitive sentence structure.Three successive sentences begin with "Snap Sync." Consider rewording for better readability.
- Snap Sync significantly improves the experience of syncing an OP Stack node. Snap Sync is a native feature of go-ethereum that is now optionally enabled on `op-node` & `op-geth`. Snap Sync works by downloading a snapshot of the state from other nodes on the network and is then able to start executing blocks from the completed state rather than having to re-execute every single block. + Snap Sync significantly improves the experience of syncing an OP Stack node. This native feature of go-ethereum is now optionally enabled on `op-node` & `op-geth`. It works by downloading a snapshot of the state from other nodes on the network and can then start executing blocks from the completed state rather than having to re-execute every single block.
Line range hint
14-14: Use a shorter alternative for "able to."Consider using "can then" instead of "is then able to" for conciseness.
- and is then able to start executing blocks from the completed state rather than having to re-execute every single block. + and can then start executing blocks from the completed state rather than having to re-execute every single block.pages/builders/chain-operators/management/operations.mdx (1)
Line range hint
155-155: Clarify the term "peer to peer."Did you mean "peered" or "to peer"? Consider rephrasing for clarity.
- If you already have peer to peer synchronization, add the new node to the `--p2p.static` list so it can synchronize. + If you already have peered synchronization, add the new node to the `--p2p.static` list so it can synchronize.pages/builders/chain-operators/tutorials/create-l2-rollup.mdx (18)
Line range hint
21-21: Consider using an alternative to strengthen your wording.- This tutorial is **designed for developers** who want to learn about the OP Stack by spinning up an OP Stack testnet chain. + This tutorial is **intended for developers** who want to learn about the OP Stack by setting up an OP Stack testnet chain.
Line range hint
22-22: Consider removing “of” to be more concise.- You'll walk through the full deployment process and teach you all of the components that make up the OP Stack, and **you'll end up with your very own OP Stack testnet**. + You'll walk through the full deployment process and learn all the components that make up the OP Stack, and **you'll end up with your very own OP Stack testnet**.
Line range hint
25-25: If this is a compound adjective that modifies the following noun, use a hyphen.- **The OP Stack is free and open source software licensed entirely under the MIT license**. + **The OP Stack is free and open-source software licensed entirely under the MIT license**.
Line range hint
63-63: It appears that a comma is missing.- In this tutorial you'll be using the [`op-node` implementation](https://github.com/ethereum-optimism/optimism/tree/v1.1.4/op-node) found within the [Optimism Monorepo](https://github.com/ethereum-optimism/optimism). + In this tutorial, you'll be using the [`op-node` implementation](https://github.com/ethereum-optimism/optimism/tree/v1.1.4/op-node) found within the [Optimism Monorepo](https://github.com/ethereum-optimism/optimism).
Line range hint
70-70: It appears that a comma is missing.- In this tutorial you'll be using the [`op-geth` implementation](https://github.com/ethereum-optimism/op-geth) found within the [`op-geth` repository](https://github.com/ethereum-optimism/op-geth). + In this tutorial, you'll be using the [`op-geth` implementation](https://github.com/ethereum-optimism/op-geth) found within the [`op-geth` repository](https://github.com/ethereum-optimism/op-geth).
Line range hint
75-75: ‘on a regular basis’ might be wordy. Consider a shorter alternative.- The Batcher runs continuously alongside the Sequencer and publishes transactions in batches (hence the name) on a regular basis. + The Batcher runs continuously alongside the Sequencer and regularly publishes transactions in batches (hence the name).
Line range hint
82-82: Consider adding a comma here.- It's likely that the Proposer will be removed in the future, but for now it's a necessary component of the OP Stack. + It's likely that the Proposer will be removed in the future, but for now, it's a necessary component of the OP Stack.
Line range hint
148-148: Possible missing preposition found.- <Callout> You're using the home directory `~/` as the work directory for this tutorial for simplicity. + <Callout> You're using the home directory `~/` as the work directory for this tutorial for simplicity.
Line range hint
183-183: Consider removing “of” to be more concise.- Run the following script and double check that you have all of the required versions installed. + Run the following script and double-check that you have all the required versions installed.
Line range hint
196-196: This phrase is redundant. Consider using “inside”.- {<h3>Build the various packages inside of the Optimism Monorepo</h3>} + {<h3>Build the various packages inside the Optimism Monorepo</h3>}
Line range hint
263-263: The phrase ‘has the ability to’ might be wordy. Consider using “can”.- The `Admin` address has the ability to upgrade contracts. + The `Admin` address can upgrade contracts.
Line range hint
376-376: This phrase is redundant. Consider using “inside”.- Currently, chain configuration lives inside of the [`contracts-bedrock`](https://github.com/ethereum-optimism/optimism/tree/v1.1.4/packages/contracts-bedrock) package in the form of a JSON file. + Currently, chain configuration lives inside the [`contracts-bedrock`](https://github.com/ethereum-optimism/optimism/tree/v1.1.4/packages/contracts-bedrock) package in the form of a JSON file.
Line range hint
394-394: This phrase is redundant. Consider using “inside”.- Run the following script to generate the `getting-started.json` configuration file inside of the `deploy-config` directory. + Run the following script to generate the `getting-started.json` configuration file inside the `deploy-config` directory.
Line range hint
429-429: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).- If the command returns `69` then the contract has been deployed and you can safely skip this section. + If the command returns `69`, then the contract has been deployed, and you can safely skip this section.
Line range hint
518-518: Possible missing comma found.- Next you'll create a [JSON Web Token](https://jwt.io/introduction) that will be used to authenticate the Consensus Client and the Execution Client. + Next, you'll create a [JSON Web Token](https://jwt.io/introduction) that will be used to authenticate the Consensus Client and the Execution Client.
Line range hint
542-542: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.- You're going to be running a Sequencer node, so you'll need to import the `Sequencer` private key that you generated earlier. + You're going to be running a Sequencer node, so you must import the `Sequencer` private key generated earlier.
Line range hint
662-662: This phrase is redundant. Consider using “inside”.- you'll start to see blocks being created inside of `op-geth`. + you'll start to see blocks being created inside `op-geth`.
Line range hint
692-692: The phrase ‘a lot of’ might be wordy and overused. Consider using an alternative.- it can expend ETH quickly if there are a lot of transactions to publish. + it can expend ETH quickly if there are many transactions to publish.pages/builders/node-operators/configuration/execution-config.mdx (14)
Line range hint
26-35: Consider rewording to avoid repetitive sentence structure.- <Tabs.Tab>`--allow-insecure-unlock`</Tabs.Tab> - <Tabs.Tab>`--allow-insecure-unlock=false`</Tabs.Tab> - <Tabs.Tab>`GETH_ALLOW_INSECURE_UNLOCK=false`</Tabs.Tab> + <Tabs.Tab>`--allow-insecure-unlock`</Tabs.Tab> + <Tabs.Tab>`Example: --allow-insecure-unlock=false`</Tabs.Tab> + <Tabs.Tab>`Environment Variable: GETH_ALLOW_INSECURE_UNLOCK=false`</Tabs.Tab>
Line range hint
36-45: Consider rewording to avoid repetitive sentence structure.- <Tabs.Tab>`--keystore <value>`</Tabs.Tab> - <Tabs.Tab>`--keystore=/path/to/keystore`</Tabs.Tab> - <Tabs.Tab>`GETH_KEYSTORE=/path/to/keystore`</Tabs.Tab> + <Tabs.Tab>`--keystore <value>`</Tabs.Tab> + <Tabs.Tab>`Example: --keystore=/path/to/keystore`</Tabs.Tab> + <Tabs.Tab>`Environment Variable: GETH_KEYSTORE=/path/to/keystore`</Tabs.Tab>
Line range hint
46-55: Consider rewording to avoid repetitive sentence structure.- <Tabs.Tab>`--lightkdf`</Tabs.Tab> - <Tabs.Tab>`--lightkdf=false`</Tabs.Tab> - <Tabs.Tab>`GETH_LIGHTKDF=false`</Tabs.Tab> + <Tabs.Tab>`--lightkdf`</Tabs.Tab> + <Tabs.Tab>`Example: --lightkdf=false`</Tabs.Tab> + <Tabs.Tab>`Environment Variable: GETH_LIGHTKDF=false`</Tabs.Tab>
Line range hint
56-65: Consider rewording to avoid repetitive sentence structure.- <Tabs.Tab>`--password <value>`</Tabs.Tab> - <Tabs.Tab>`--password=/path/to/passwordfile`</Tabs.Tab> - <Tabs.Tab>`GETH_PASSWORD=/path/to/passwordfile`</Tabs.Tab> + <Tabs.Tab>`--password <value>`</Tabs.Tab> + <Tabs.Tab>`Example: --password=/path/to/passwordfile`</Tabs.Tab> + <Tabs.Tab>`Environment Variable: GETH_PASSWORD=/path/to/passwordfile`</Tabs.Tab>
Line range hint
66-75: Fix the missing closing quotation mark and consider rewording to avoid repetitive sentence structure.- Path to the smartcard daemon (pcscd) socket file. The default value is `"/run/pcscd/pcscd.comm"`. + Path to the smartcard daemon (pcscd) socket file. The default value is `"/run/pcscd/pcscd.comm"`. ```diff - <Tabs.Tab>`--pcscdpath <value>`</Tabs.Tab> - <Tabs.Tab>`--pcscdpath=/custom/path/to/pcscd.comm`</Tabs.Tab> - <Tabs.Tab>`GETH_PCSCDPATH=/custom/path/to/pcscd.comm`</Tabs.Tab> + <Tabs.Tab>`--pcscdpath <value>`</Tabs.Tab> + <Tabs.Tab>`Example: --pcscdpath=/custom/path/to/pcscd.comm`</Tabs.Tab> + <Tabs.Tab>`Environment Variable: GETH_PCSCDPATH=/custom/path/to/pcscd.comm`</Tabs.Tab>
Line range hint
76-85: Consider rewording to avoid repetitive sentence structure.- <Tabs.Tab>`--signer <value>`</Tabs.Tab> - <Tabs.Tab>`--signer=/path/to/ipcfile`</Tabs.Tab> - <Tabs.Tab>`GETH_SIGNER=/path/to/ipcfile`</Tabs.Tab> + <Tabs.Tab>`--signer <value>`</Tabs.Tab> + <Tabs.Tab>`Example: --signer=/path/to/ipcfile`</Tabs.Tab> + <Tabs.Tab>`Environment Variable: GETH_SIGNER=/path/to/ipcfile`</Tabs.Tab>
Line range hint
86-95: Consider rewording to avoid repetitive sentence structure.- <Tabs.Tab>`--unlock <account address>`</Tabs.Tab> - <Tabs.Tab>`--unlock=0x1234,0x5678`</Tabs.Tab> - <Tabs.Tab>`GETH_UNLOCK=0x1234,0x5678`</Tabs.Tab> + <Tabs.Tab>`--unlock <account address>`</Tabs.Tab> + <Tabs.Tab>`Example: --unlock=0x1234,0x5678`</Tabs.Tab> + <Tabs.Tab>`Environment Variable: GETH_UNLOCK=0x1234,0x5678`</Tabs.Tab>
Line range hint
96-105: Consider rewording to avoid repetitive sentence structure.- <Tabs.Tab>`--usb`</Tabs.Tab> - <Tabs.Tab>`--usb=false`</Tabs.Tab> - <Tabs.Tab>`GETH_USB=false`</Tabs.Tab> + <Tabs.Tab>`--usb`</Tabs.Tab> + <Tabs.Tab>`Example: --usb=false`</Tabs.Tab> + <Tabs.Tab>`Environment Variable: GETH_USB=false`</Tabs.Tab>
Line range hint
108-117: Consider rewording to avoid repetitive sentence structure.- <Tabs.Tab>`--authrpc.addr <value>`</Tabs.Tab> - <Tabs.Tab>`--authrpc.addr="localhost"`</Tabs.Tab> - <Tabs.Tab>`GETH_AUTHRPC_ADDR="localhost"`</Tabs.Tab> + <Tabs.Tab>`--authrpc.addr <value>`</Tabs.Tab> + <Tabs.Tab>`Example: --authrpc.addr="localhost"`</Tabs.Tab> + <Tabs.Tab>`Environment Variable: GETH_AUTHRPC_ADDR="localhost"`</Tabs.Tab>
Line range hint
118-127: Consider rewording to avoid repetitive sentence structure.- <Tabs.Tab>`--authrpc.jwtsecret <value>`</Tabs.Tab> - <Tabs.Tab>`--authrpc.jwtsecret=/path/to/jwtsecret`</Tabs.Tab> - <Tabs.Tab>`GETH_AUTHRPC_JWTSECRET=/path/to/jwtsecret`</Tabs.Tab> + <Tabs.Tab>`--authrpc.jwtsecret <value>`</Tabs.Tab> + <Tabs.Tab>`Example: --authrpc.jwtsecret=/path/to/jwtsecret`</Tabs.Tab> + <Tabs.Tab>`Environment Variable: GETH_AUTHRPC_JWTSECRET=/path/to/jwtsecret`</Tabs.Tab>
Line range hint
128-137: Consider rewording to avoid repetitive sentence structure.- <Tabs.Tab>`--authrpc.port <value>`</Tabs.Tab> - <Tabs.Tab>`--authrpc.port=8551`</Tabs.Tab> - <Tabs.Tab>`GETH_AUTHRPC_PORT=8551`</Tabs.Tab> + <Tabs.Tab>`--authrpc.port <value>`</Tabs.Tab> + <Tabs.Tab>`Example: --authrpc.port=8551`</Tabs.Tab> + <Tabs.Tab>`Environment Variable: GETH_AUTHRPC_PORT=8551`</Tabs.Tab>
Line range hint
138-148: Consider rewording to avoid repetitive sentence structure.- <Tabs.Tab>`--authrpc.vhosts <value>`</Tabs.Tab> - <Tabs.Tab>`--authrpc.vhosts="localhost"`</Tabs.Tab> - <Tabs.Tab>`GETH_AUTHRPC_VHOSTS="localhost"`</Tabs.Tab> + <Tabs.Tab>`--authrpc.vhosts <value>`</Tabs.Tab> + <Tabs.Tab>`Example: --authrpc.vhosts="localhost"`</Tabs.Tab> + <Tabs.Tab>`Environment Variable: GETH_AUTHRPC_VHOSTS="localhost"`</Tabs.Tab>
Line range hint
149-158: Consider rewording to avoid repetitive sentence structure.- <Tabs.Tab>`--exec <value>`</Tabs.Tab> - <Tabs.Tab>`--exec="console.log('Hello, World!')"`</Tabs.Tab> - <Tabs.Tab>`GETH_EXEC="console.log('Hello, World!')"`</Tabs.Tab> + <Tabs.Tab>`--exec <value>`</Tabs.Tab> + <Tabs.Tab>`Example: --exec="console.log('Hello, World!')"`</Tabs.Tab> + <Tabs.Tab>`Environment Variable: GETH_EXEC="console.log('Hello, World!')"`</Tabs.Tab>
Line range hint
159-169: Consider rewording to avoid repetitive sentence structure.- <Tabs.Tab>`--graphql`</Tabs.Tab> - <Tabs.Tab>`--graphql=false`</Tabs.Tab> - <Tabs.Tab>`GETH_GRAPHQL=false`</Tabs.Tab> + <Tabs.Tab>`--graphql`</Tabs.Tab> + <Tabs.Tab>`Example: --graphql=false`</Tabs.Tab> + <Tabs.Tab>`Environment Variable: GETH_GRAPHQL=false`</Tabs.Tab>
part 1 of node revision: