Proposer setup guide #1645
Proposer setup guide #1645
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThis set of changes introduces a new tutorial, "Spinning up the proposer," which guides operators through setting up and configuring an OP Stack proposer, including prerequisites, environment setup, and operational instructions. The deployment landing page and metadata are updated to include this new guide. Several existing tutorials are updated to revise and expand their "Next Steps" sections, adding and reordering links to related resources such as the new proposer tutorial, absolute prestate tutorial, migrating to permissionless fault proofs guide, and fault proofs explainer. Sequence Diagram(s)sequenceDiagram
participant Operator
participant Proposer
participant L1_Node
participant L2_Node
participant DisputeGameFactory
Operator->>Proposer: Configure environment & start proposer
Proposer->>L2_Node: Connect to L2 RPC
Proposer->>L1_Node: Connect to L1 RPC
Proposer->>DisputeGameFactory: Interact for dispute game creation
Proposer->>L1_Node: Post L2 state roots
Proposer->>Operator: Provide status/logs
Possibly related PRs
Suggested labels
Suggested reviewers
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (13)
pages/operators/chain-operators/configuration/batcher.mdx (6)
22-23: Avoid bold for emphasis and fix comma usageThe bold markup around “definitive guide” is used for emphasis; per style guidelines, prefer plain text or italics. Also remove the unnecessary comma before “to make” in the second sentence.
Suggested diff:
- This page provides the **definitive guide** for OP Stack batcher configuration, serving as the single source of truth for chain operators. - The op-batcher posts L2 sequencer data to the L1, to make it available for verifiers. + This page provides the definitive guide for OP Stack batcher configuration, serving as the single source of truth for chain operators. + The op-batcher posts L2 sequencer data to the L1 to make it available for verifiers.
123-123: Hyphenate compound adjectiveUse a hyphen for the compound modifier “third-party bridges” to conform to adjective-hyphenation rules.
Suggested diff:
- often Centralized Exchanges or third party bridges wait until transactions are marked safe before processing deposits and withdrawal + often Centralized Exchanges or third-party bridges wait until transactions are marked safe before processing deposits and withdrawals🧰 Tools
🪛 LanguageTool
[uncategorized] ~123-~123: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...fe head, often Centralized Exchanges or third party bridges wait until transactions are mar...(EN_COMPOUND_ADJECTIVE_INTERNAL)
169-169: Add missing comma for clarityInsert a comma after “gas” to clearly separate clauses.
Suggested diff:
- This is to avoid sudden spikes in L1 DA-usage consuming too much available gas and causing a backlog in batcher transactions. + This is to avoid sudden spikes in L1 DA-usage consuming too much available gas, and causing a backlog in batcher transactions.🧰 Tools
🪛 LanguageTool
[uncategorized] ~169-~169: Possible missing comma found.
Context: ...This is to avoid sudden spikes in L1 DA-usage consuming too much available gas and ca...(AI_HYDRA_LEO_MISSING_COMMA)
178-178: Clarify the requirement syntaxAdd “to” for a smoother connection between the version requirement and the action.
Suggested diff:
- Requires op-geth version `v1.101411.1` or later - Enable the `miner` API namespace: `GETH_HTTP_API: web3,debug,eth,txpool,net,miner` + Requires op-geth version `v1.101411.1` or later to enable the `miner` API namespace: + `GETH_HTTP_API: web3,debug,eth,txpool,net,miner`🧰 Tools
🪛 LanguageTool
[uncategorized] ~178-~178: Possible missing preposition found.
Context: ...geth versionv1.101411.1or later * Enable theminerAPI namespace: `GETH_HTTP_A...(AI_HYDRA_LEO_MISSING_TO)
221-221: Insert comma before coordinating conjunctionAdd a comma before “or” in the list to match comma-style rules.
Suggested diff:
- by setting the `--data-availability-type=<blobs|calldata|auto>` flag or with the `OP_BATCHER_DATA_AVAILABILITY_TYPE` env variable. + by setting the `--data-availability-type=<blobs|calldata|auto>` flag, or with the `OP_BATCHER_DATA_AVAILABILITY_TYPE` env variable.🧰 Tools
🪛 LanguageTool
[uncategorized] ~221-~221: Possible missing comma found.
Context: ...vailability-type=<blobs|calldata|auto>flag or with theOP_BATCHER_DATA_AVAILABILI...(AI_HYDRA_LEO_MISSING_COMMA)
257-257: Streamline phrasingReplace “by the use of” with “using” for brevity and clarity.
Suggested diff:
- This is accomplished by the use of multi-frame channels, see the [specs]... + This is accomplished using multi-frame channels; see the [specs]...🧰 Tools
🪛 LanguageTool
[style] ~257-~257: ‘by the use of’ might be wordy. Consider a shorter alternative.
Context: ... blob transaction. This is accomplished by the use of multi-frame channels, see the [specs](h...(EN_WORDINESS_PREMIUM_BY_THE_USE_OF)
pages/operators/chain-operators/tutorials/dispute-games.mdx (2)
152-152: Use sentence case for headingsPer guidelines, H2 headings should be sentence case. Change “## Next Steps” to:
## Next steps
154-157: Fix bullet styling and phrasing
- Remove duplicate “deploying new dispute games” link.
- Capitalize and use an imperative (“Check out…” instead of “checkout”).
- Add periods for consistency.
Suggested:
- * For more detail on deploying new dispute games with OPCM, [see the docs](/operators/chain-operators/tutorials/dispute-games). - * Learn about [absolute prestate](/operators/chain-operators/tutorials/absolute-prestate) - * checkout the [migrating to permissionless fault proofs](/operators/chain-operators/tutorials/migrating-permissionless) guide - * [Fault proofs explainer](/stack/fault-proofs/explainer) + * Check out the [absolute prestate guide](/operators/chain-operators/tutorials/absolute-prestate). + * Check out the [migrating to permissionless fault proofs guide](/operators/chain-operators/tutorials/migrating-permissionless). + * Read the [Fault proofs explainer](/stack/fault-proofs/explainer).pages/operators/chain-operators/tutorials/absolute-prestate.mdx (1)
278-278: Use sentence case for headingsPer guidelines, H2 headings should be sentence case. Change:
## Next Stepsto:
## Next stepspages/operators/chain-operators/tutorials/proposer-setup-guide.mdx (4)
23-23: Refine introductory sentence to remove personal pronouns and improve clarityAvoid using “we” in communal documentation; rephrase “so we can prove withdrawal validity” to “to prove withdrawal validity.” Also consider changing “state roots data” to “state root data” for consistency.
235-237: Use en dash for numeric rangesReplace hyphens in ranges (e.g., “1-6 hours”, “30-60 minutes”, “5-15 minutes”) with an en dash (–) for typographical accuracy.
🧰 Tools
🪛 LanguageTool
[typographical] ~235-~235: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...-------------- | | Mainnet Production | 1-6 hours | Balance cost vs. wi...(HYPHEN_TO_EN)
[typographical] ~236-~236: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...thdrawal speed | | High-Value Testnet | 30-60 minutes | More frequent for tes...(HYPHEN_TO_EN)
[typographical] ~237-~237: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...esting | | Development | 5-15 minutes | Fast iteration cycle...(HYPHEN_TO_EN)
239-241: Remove bold formatting for emphasisPer style guidelines, avoid bold for emphasis. Change “Important:” to “Important:” without bold.
277-278: Capitalize and correct the verb in the Next steps bulletChange “checkout the migrating to permissionless fault proofs guide” to “Check out the migrating to permissionless fault proofs guide” for consistency and proper imperative form.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
pages/operators/chain-operators/configuration/batcher.mdx(5 hunks)pages/operators/chain-operators/tutorials/_meta.json(1 hunks)pages/operators/chain-operators/tutorials/absolute-prestate.mdx(1 hunks)pages/operators/chain-operators/tutorials/dispute-games.mdx(1 hunks)pages/operators/chain-operators/tutorials/migrating-permissionless.mdx(1 hunks)pages/operators/chain-operators/tutorials/proposer-setup-guide.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with the following criteria: - First, check the frontmatter section at the top of the file: 1. For regular pages, ensure AL...
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- First, check the frontmatter section at the top of the file:
- For regular pages, ensure ALL these fields are present and not empty:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] personas: [non-empty array] categories: [non-empty array] content_type: [valid type] ---
- For landing pages (index.mdx or files with ), only these fields are required:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] ---
- If any required fields are missing or empty, comment:
'This file appears to be missing required metadata. Please check keywords.config.yaml for valid options and add the required fields manually. You can validate your changes by running:pnpm validate-metadata ```'- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
pages/operators/chain-operators/tutorials/migrating-permissionless.mdxpages/operators/chain-operators/tutorials/absolute-prestate.mdxpages/operators/chain-operators/tutorials/dispute-games.mdxpages/operators/chain-operators/configuration/batcher.mdxpages/operators/chain-operators/tutorials/proposer-setup-guide.mdx
🪛 LanguageTool
pages/operators/chain-operators/configuration/batcher.mdx
[uncategorized] ~123-~123: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...fe head, often Centralized Exchanges or third party bridges wait until transactions are mar...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~169-~169: Possible missing comma found.
Context: ...This is to avoid sudden spikes in L1 DA-usage consuming too much available gas and ca...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~178-~178: Possible missing preposition found.
Context: ...geth version v1.101411.1 or later * Enable the miner API namespace: `GETH_HTTP_A...
(AI_HYDRA_LEO_MISSING_TO)
[uncategorized] ~221-~221: Possible missing comma found.
Context: ...vailability-type=<blobs|calldata|auto>flag or with theOP_BATCHER_DATA_AVAILABILI...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~257-~257: ‘by the use of’ might be wordy. Consider a shorter alternative.
Context: ... blob transaction. This is accomplished by the use of multi-frame channels, see the [specs](h...
(EN_WORDINESS_PREMIUM_BY_THE_USE_OF)
pages/operators/chain-operators/tutorials/proposer-setup-guide.mdx
[typographical] ~235-~235: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...-------------- | | Mainnet Production | 1-6 hours | Balance cost vs. wi...
(HYPHEN_TO_EN)
[typographical] ~236-~236: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...thdrawal speed | | High-Value Testnet | 30-60 minutes | More frequent for tes...
(HYPHEN_TO_EN)
[typographical] ~237-~237: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...esting | | Development | 5-15 minutes | Fast iteration cycle...
(HYPHEN_TO_EN)
🪛 Gitleaks (8.26.0)
pages/operators/chain-operators/tutorials/proposer-setup-guide.mdx
116-116: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
🔇 Additional comments (2)
pages/operators/chain-operators/tutorials/_meta.json (1)
3-3: New tutorial metadata entry looks goodThe new
"proposer-setup-guide": "Spin up your proposer"entry correctly matches the new MDX filename and title. Everything appears consistent.pages/operators/chain-operators/tutorials/proposer-setup-guide.mdx (1)
1-17: Complete frontmatter metadataAll required fields (title, lang, description, content_type, topic, personas, categories) are present and non-empty.
pages/operators/chain-operators/tutorials/migrating-permissionless.mdx
Outdated
Show resolved
Hide resolved
pages/operators/chain-operators/tutorials/absolute-prestate.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
…less.mdx Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
pages/operators/chain-operators/tutorials/proposer-setup-guide.mdx (2)
23-23: Avoid first-person plural pronoun “we”.The sentence uses “so we can prove withdrawal validity.” Replace with “to prove withdrawal validity” to maintain an impersonal tone and avoid personal pronouns.
218-220: Use en dash for numeric ranges in tables.Replace hyphens in “1-6 hours”, “30-60 minutes”, and “5-15 minutes” with en dashes (e.g., “1–6 hours”) for typographical accuracy.
🧰 Tools
🪛 LanguageTool
[typographical] ~218-~218: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...-------------- | | Mainnet Production | 1-6 hours | Balance cost vs. wi...(HYPHEN_TO_EN)
[typographical] ~219-~219: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...thdrawal speed | | High-Value Testnet | 30-60 minutes | More frequent for tes...(HYPHEN_TO_EN)
[typographical] ~220-~220: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...esting | | Development | 5-15 minutes | Fast iteration cycle...(HYPHEN_TO_EN)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
pages/operators/chain-operators/tutorials/absolute-prestate.mdx(1 hunks)pages/operators/chain-operators/tutorials/migrating-permissionless.mdx(1 hunks)pages/operators/chain-operators/tutorials/proposer-setup-guide.mdx(1 hunks)words.txt(0 hunks)
💤 Files with no reviewable changes (1)
- words.txt
✅ Files skipped from review due to trivial changes (1)
- pages/operators/chain-operators/tutorials/migrating-permissionless.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
- pages/operators/chain-operators/tutorials/absolute-prestate.mdx
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with the following criteria: - First, check the frontmatter section at the top of the file: 1. For regular pages, ensure AL...
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- First, check the frontmatter section at the top of the file:
- For regular pages, ensure ALL these fields are present and not empty:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] personas: [non-empty array] categories: [non-empty array] content_type: [valid type] ---
- For landing pages (index.mdx or files with ), only these fields are required:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] ---
- If any required fields are missing or empty, comment:
'This file appears to be missing required metadata. Please check keywords.config.yaml for valid options and add the required fields manually. You can validate your changes by running:pnpm validate-metadata ```'- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
pages/operators/chain-operators/tutorials/proposer-setup-guide.mdx
🪛 LanguageTool
pages/operators/chain-operators/tutorials/proposer-setup-guide.mdx
[typographical] ~218-~218: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...-------------- | | Mainnet Production | 1-6 hours | Balance cost vs. wi...
(HYPHEN_TO_EN)
[typographical] ~219-~219: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...thdrawal speed | | High-Value Testnet | 30-60 minutes | More frequent for tes...
(HYPHEN_TO_EN)
[typographical] ~220-~220: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...esting | | Development | 5-15 minutes | Fast iteration cycle...
(HYPHEN_TO_EN)
🪛 Gitleaks (8.26.0)
pages/operators/chain-operators/tutorials/proposer-setup-guide.mdx
100-100: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
- GitHub Check: pr-workflow
🔇 Additional comments (2)
pages/operators/chain-operators/tutorials/proposer-setup-guide.mdx (2)
1-17: Frontmatter metadata is complete and valid.All required fields (title, lang, description, content_type, topic, personas, categories) are present and non-empty.
26-27:✅ Verification successful
Verify that all linked pages exist and resolve correctly.
Please ensure the relative links to other tutorials and tools (e.g., rollup creation, dispute games, migrating to permissionless fault proofs, fee calculator) match actual file paths.
Run this script from the repo root to confirm the files exist:
Also applies to: 258-262
🏁 Script executed:
#!/bin/bash # Verify linked filenames exist files=( "pages/operators/chain-operators/tutorials/create-l2-rollup.mdx" "pages/operators/chain-operators/tutorials/dispute-games.mdx" "pages/operators/chain-operators/tutorials/migrating-permissionless.mdx" "pages/operators/chain-operators/tools/fee-calculator.mdx" ) for f in "${files[@]}"; do if [[ ! -f "$f" ]]; then echo "Error: $f not found" fi doneLength of output: 671
All linked pages verified
The relative links to the rollup creation, dispute games, migrating to permissionless fault proofs, and fee calculator tutorials all point to existing files inpages/operators/chain-operators/. No further action needed.
pages/operators/chain-operators/tutorials/proposer-setup-guide.mdx
Outdated
Show resolved
Hide resolved
pages/operators/chain-operators/tutorials/proposer-setup-guide.mdx
Outdated
Show resolved
Hide resolved
pages/operators/chain-operators/tutorials/proposer-setup-guide.mdx
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
pages/operators/chain-operators/tutorials/proposer-setup-guide.mdx (3)
23-24: Avoid first-person pronouns
Replace "so we can prove withdrawal validity" with an impersonal construction.- After you have spun up your sequencer, you need to attach a proposer to post your L2 state roots data back onto L1 so we can prove withdrawal validity. + After you have spun up your sequencer, you need to attach a proposer to post your L2 state roots data back onto L1 to enable withdrawal validity proofs.
216-218: Use en dashes for ranges in table
Replace hyphens with en dashes for consistency and typographical correctness.-| Mainnet Production | 1-6 hours | Balance cost vs. withdrawal speed | -| High-Value Testnet | 30-60 minutes | More frequent for testing | -| Development | 5-15 minutes | Fast iteration cycles | +| Mainnet Production | 1–6 hours | Balance cost vs. withdrawal speed | +| High-Value Testnet | 30–60 minutes | More frequent for testing | +| Development | 5–15 minutes | Fast iteration cycles |🧰 Tools
🪛 LanguageTool
[typographical] ~216-~216: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...-------------- | | Mainnet Production | 1-6 hours | Balance cost vs. wi...(HYPHEN_TO_EN)
[typographical] ~217-~217: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...thdrawal speed | | High-Value Testnet | 30-60 minutes | More frequent for tes...(HYPHEN_TO_EN)
[typographical] ~218-~218: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...esting | | Development | 5-15 minutes | Fast iteration cycle...(HYPHEN_TO_EN)
258-258: Correct “checkout” to “check out”
Use the imperative verb form as two words.-* checkout the [migrating to permissionless fault proofs](/operators/chain-operators/tutorials/migrating-permissionless) guide +* Check out the [migrating to permissionless fault proofs](/operators/chain-operators/tutorials/migrating-permissionless) guide
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
pages/operators/chain-operators/tutorials/proposer-setup-guide.mdx(1 hunks)words.txt(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- words.txt
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with the following criteria: - First, check the frontmatter section at the top of the file: 1. For regular pages, ensure AL...
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- First, check the frontmatter section at the top of the file:
- For regular pages, ensure ALL these fields are present and not empty:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] personas: [non-empty array] categories: [non-empty array] content_type: [valid type] ---
- For landing pages (index.mdx or files with ), only these fields are required:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] ---
- If any required fields are missing or empty, comment:
'This file appears to be missing required metadata. Please check keywords.config.yaml for valid options and add the required fields manually. You can validate your changes by running:pnpm validate-metadata ```'- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
pages/operators/chain-operators/tutorials/proposer-setup-guide.mdx
🪛 LanguageTool
pages/operators/chain-operators/tutorials/proposer-setup-guide.mdx
[typographical] ~216-~216: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...-------------- | | Mainnet Production | 1-6 hours | Balance cost vs. wi...
(HYPHEN_TO_EN)
[typographical] ~217-~217: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...thdrawal speed | | High-Value Testnet | 30-60 minutes | More frequent for tes...
(HYPHEN_TO_EN)
[typographical] ~218-~218: If specifying a range, consider using an en dash instead of a hyphen.
Context: ...esting | | Development | 5-15 minutes | Fast iteration cycle...
(HYPHEN_TO_EN)
🪛 Gitleaks (8.26.0)
pages/operators/chain-operators/tutorials/proposer-setup-guide.mdx
98-98: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
- GitHub Check: pr-workflow
🔇 Additional comments (1)
pages/operators/chain-operators/tutorials/proposer-setup-guide.mdx (1)
1-17: Frontmatter validation
All required metadata fields (title,lang,description,topic,personas,categories,content_type) are present and non-empty.
pages/operators/chain-operators/tutorials/proposer-setup-guide.mdx
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (6)
pages/operators/chain-operators/configuration/batcher.mdx (3)
22-22: Avoid bold for emphasis per style guidelines
The use of**definitive guide**applies bold for emphasis, which the docs style discourages. Consider removing the bold markers (e.g., revert to plain text).
73-73: Refine wording and fix comma splice
"This is accomplished by the use of multi-frame channels, see the specs..." is wordy and contains a comma splice. Suggest:-The `op-batcher` has the capabilities to send multiple blobs per single blob transaction. This is accomplished by the use of multi-frame channels, see the [specs](...) +The `op-batcher` can send multiple blobs per transaction using multi-frame channels. See the [specs](...) for more details on channels and frames.🧰 Tools
🪛 LanguageTool
[style] ~73-~73: ‘by the use of’ might be wordy. Consider a shorter alternative.
Context: ... blob transaction. This is accomplished by the use of multi-frame channels, see the [specs](h...(EN_WORDINESS_PREMIUM_BY_THE_USE_OF)
168-168: Use restrictive clause and consistent variable naming
Replace "which aren't" with "that aren't" for a restrictive clause, and refer explicitly toOP_BATCHER_MAX_CHANNEL_DURATIONfor consistency:-Lower throughput chains, which aren't filling up channels before the `MAX_CHANNEL_DURATION` is hit, may save gas by increasing the `MAX_CHANNEL_DURATION`. +Lower throughput chains that aren't filling channels before the `OP_BATCHER_MAX_CHANNEL_DURATION` is reached may save gas by increasing that value.pages/operators/chain-operators/deploy/proposer-setup-guide.mdx (3)
23-25: Use imperative voice and avoid personal pronouns. Replace “After you have spun up your sequencer… so we can prove” with an imperative statement and remove “you”/“we.”-After you have spun up your sequencer, you need to attach a proposer to post your L2 state roots data back onto L1 so we can prove withdrawal validity. +After spinning up a sequencer, attach a proposer to post L2 state roots back to L1 to prove withdrawal validity.
154-155: Correct verb form and casing. Change “checkout” to “Check out” and maintain sentence case in the “Next steps” list.-* checkout the [migrating to permissionless fault proofs](/operators/chain-operators/tutorials/migrating-permissionless) guide +* Check out the [migrating to permissionless fault proofs](/operators/chain-operators/tutorials/migrating-permissionless) guide
19-130: Editorial: Consistent imperative tone. Review the entire guide for remaining instances of “you,” “your,” and “we,” converting them to imperative constructions or passive voice to align with the documentation style guide.🧰 Tools
🪛 Gitleaks (8.26.0)
85-85: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
pages/operators/chain-operators/configuration/batcher.mdx(5 hunks)pages/operators/chain-operators/deploy.mdx(1 hunks)pages/operators/chain-operators/deploy/_meta.json(1 hunks)pages/operators/chain-operators/deploy/proposer-setup-guide.mdx(1 hunks)words.txt(1 hunks)
✅ Files skipped from review due to trivial changes (3)
- pages/operators/chain-operators/deploy.mdx
- pages/operators/chain-operators/deploy/_meta.json
- words.txt
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with the following criteria: - First, check the frontmatter section at the top of the file: 1. For regular pages, ensure AL...
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- First, check the frontmatter section at the top of the file:
- For regular pages, ensure ALL these fields are present and not empty:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] personas: [non-empty array] categories: [non-empty array] content_type: [valid type] ---
- For landing pages (index.mdx or files with ), only these fields are required:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] ---
- If any required fields are missing or empty, comment:
'This file appears to be missing required metadata. Please check keywords.config.yaml for valid options and add the required fields manually. You can validate your changes by running:pnpm validate-metadata ```'- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
pages/operators/chain-operators/deploy/proposer-setup-guide.mdxpages/operators/chain-operators/configuration/batcher.mdx
🪛 Gitleaks (8.26.0)
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx
85-85: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
🪛 LanguageTool
pages/operators/chain-operators/configuration/batcher.mdx
[style] ~73-~73: ‘by the use of’ might be wordy. Consider a shorter alternative.
Context: ... blob transaction. This is accomplished by the use of multi-frame channels, see the [specs](h...
(EN_WORDINESS_PREMIUM_BY_THE_USE_OF)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
🔇 Additional comments (5)
pages/operators/chain-operators/configuration/batcher.mdx (4)
34-38: No issues: the additional bullet under "Batcher policy" is clear and adheres to style.
39-39: This heading update aligns with existing formatting and requires no changes.
888-896: The new "Conclusion" section is concise, informative, and follows sentence-case heading rules. It effectively summarizes the importance of batcher configuration.
897-903: The "Next steps" list is a valuable addition, guiding readers to related resources without style or formatting issues.pages/operators/chain-operators/deploy/proposer-setup-guide.mdx (1)
1-17: Frontmatter is complete. All required metadata fields (title,lang,description,content_type,topic,personas,categories) are present and non-empty.
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx (1)
23-24:⚠️ Potential issueFix broken placeholder link and remove escape characters.
The sequencer guide link is still a placeholder and uses unnecessary backslashes. Update it to the real URL and correct Markdown syntax.Example fix:
- This guide assumes you already have a functioning sequencer and the necessary [`op-deployer`](/operators/chain-operators/tools/op-deployer). If you haven't set up your sequencer yet, please refer to the \[sequencer guide]\(Todo - Add this link when it's live) first. + This guide assumes you already have a functioning sequencer and the necessary [L1 contracts deployed](/operators/chain-operators/tools/op-deployer). If you haven't set up your sequencer yet, refer to the [sequencer setup guide](/operators/chain-operators/deploy/sequencer-setup) first.🧰 Tools
🪛 LanguageTool
[grammar] ~23-~23: It appears that a hyphen is missing in the noun “To-do” (= task) or did you mean the verb “to do”?
Context: ...please refer to the [sequencer guide](Todo - Add this link when it's live) first. ...(TO_DO_HYPHEN)
🧹 Nitpick comments (1)
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx (1)
21-21: Avoid first-person pronoun.
The phrase “so we can prove withdrawal validity” uses “we”. Rephrase to remove it and make the sentence more direct.Apply this diff:
- After you have spun up your sequencer, you need to attach a proposer to post your L2 state roots data back onto L1 so we can prove withdrawal validity. + After you have spun up your sequencer, attach a proposer to post your L2 state roots data back onto L1 to prove withdrawal validity.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with the following criteria: - First, check the frontmatter section at the top of the file: 1. For regular pages, ensure AL...
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- First, check the frontmatter section at the top of the file:
- For regular pages, ensure ALL these fields are present and not empty:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] personas: [non-empty array] categories: [non-empty array] content_type: [valid type] ---
- For landing pages (index.mdx or files with ), only these fields are required:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] ---
- If any required fields are missing or empty, comment:
'This file appears to be missing required metadata. Please check keywords.config.yaml for valid options and add the required fields manually. You can validate your changes by running:pnpm validate-metadata ```'- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx
🪛 LanguageTool
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx
[grammar] ~23-~23: It appears that a hyphen is missing in the noun “To-do” (= task) or did you mean the verb “to do”?
Context: ...please refer to the [sequencer guide](Todo - Add this link when it's live) first. ...
(TO_DO_HYPHEN)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
- GitHub Check: pr-workflow
🔇 Additional comments (1)
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx (1)
1-17: Frontmatter metadata is complete.
All required fields (title,lang,description,topic,personas,categories,content_type) are present and non-empty, andcontent_type: tutorialis valid.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
pages/operators/chain-operators/configuration/batcher.mdx (1)
92-92: Add missing article before "guide on".For grammatical clarity, update:
"You can use this calculator … Please also refer to the guide on Using Blobs for chain operators."🧰 Tools
🪛 LanguageTool
[uncategorized] ~92-~92: You might be missing the article “the” here.
Context: ...figuration to use. Please also refer to guide on [Using Blobs](/operators/chain-opera...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/operators/chain-operators/configuration/batcher.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with the following criteria: - First, check the frontmatter section at the top of the file: 1. For regular pages, ensure AL...
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- First, check the frontmatter section at the top of the file:
- For regular pages, ensure ALL these fields are present and not empty:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] personas: [non-empty array] categories: [non-empty array] content_type: [valid type] ---
- For landing pages (index.mdx or files with ), only these fields are required:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] ---
- If any required fields are missing or empty, comment:
'This file appears to be missing required metadata. Please check keywords.config.yaml for valid options and add the required fields manually. You can validate your changes by running:pnpm validate-metadata ```'- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
pages/operators/chain-operators/configuration/batcher.mdx
🪛 LanguageTool
pages/operators/chain-operators/configuration/batcher.mdx
[uncategorized] ~92-~92: You might be missing the article “the” here.
Context: ...figuration to use. Please also refer to guide on [Using Blobs](/operators/chain-opera...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
- GitHub Check: pr-workflow
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx (1)
23-23:⚠️ Potential issueFix broken placeholder link and escaped syntax
The placeholder link uses incorrect escape characters and “Todo” text. Point to the live sequencer setup guide and remove backslashes.
- This guide assumes you already have a functioning sequencer and the necessary L1 contracts deployed using [`op-deployer`](/operators/chain-operators/tools/op-deployer). If you haven't set up your sequencer yet, please refer to the \[sequencer guide]\(Todo - Add this link when it's live) first. + This guide assumes a functioning sequencer and the necessary [L1 contracts deployed](/operators/chain-operators/deploy/overview). If you haven't set up a sequencer yet, refer to the [sequencer setup guide](/operators/chain-operators/deploy/sequencer-setup) first.🧰 Tools
🪛 LanguageTool
[grammar] ~23-~23: It appears that a hyphen is missing in the noun “To-do” (= task) or did you mean the verb “to do”?
Context: ...please refer to the [sequencer guide](Todo - Add this link when it's live) first. ...(TO_DO_HYPHEN)
🧹 Nitpick comments (4)
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx (4)
21-21: Revise tone for imperative style and remove first-person pronounThe sentence uses “you need to” and “we” (first-person plural). Switch to an imperative structure and remove “we.”
- After you have spun up your sequencer, you need to attach a proposer to post your L2 state roots data back onto L1 so we can prove withdrawal validity. + After spinning up a sequencer, attach a proposer to post L2 state roots back onto L1 to prove withdrawal validity.
108-108: Correct grammar in code block commentThe comment "update to paths to wherever your
.deployer/state.jsonlive" is ungrammatical.- # Copy the L1 contracts file from op-deployer, update to paths to wherever your `.deployer/state.json` live + # Copy the L1 contracts file from op-deployer and update the path to point to wherever your `.deployer/state.json` file lives
168-168: Remove first-person pronoun in commentAvoid “we built.” Use a neutral phrasing.
- # Path to the op-proposer binary we built + # Path to the op-proposer binary built earlier
245-245: Capitalize and punctuate bullet consistentlyEnsure each bullet starts with a capital letter and ends with a period for consistency.
- * checkout the [migrating to permissionless fault proofs](/operators/chain-operators/tutorials/migrating-permissionless) guide + * Checkout the [migrating to permissionless fault proofs](/operators/chain-operators/tutorials/migrating-permissionless) guide.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with the following criteria: - First, check the frontmatter section at the top of the file: 1. For regular pages, ensure AL...
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- First, check the frontmatter section at the top of the file:
- For regular pages, ensure ALL these fields are present and not empty:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] personas: [non-empty array] categories: [non-empty array] content_type: [valid type] ---
- For landing pages (index.mdx or files with ), only these fields are required:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] ---
- If any required fields are missing or empty, comment:
'This file appears to be missing required metadata. Please check keywords.config.yaml for valid options and add the required fields manually. You can validate your changes by running:pnpm validate-metadata ```'- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx
🪛 LanguageTool
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx
[grammar] ~23-~23: It appears that a hyphen is missing in the noun “To-do” (= task) or did you mean the verb “to do”?
Context: ...please refer to the [sequencer guide](Todo - Add this link when it's live) first. ...
(TO_DO_HYPHEN)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
- GitHub Check: pr-workflow
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx (1)
23-23: Replace placeholder link and fix Markdown syntax.
The sequencer guide link is a placeholder and uses escaped characters. Replace it with a proper Markdown link pointing to the live sequencer setup guide:-If you haven't set up your sequencer yet, please refer to the \[sequencer guide]\(Todo - Add this link when it's live) first. +If you haven't set up your sequencer yet, please refer to the [sequencer setup guide](/operators/chain-operators/deploy/sequencer-setup) first.
🧹 Nitpick comments (2)
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx (2)
233-233: Capitalize and punctuate this bullet consistently.
The third "Next steps" item should start with an uppercase letter and end with a period:-* checkout the [migrating to permissionless fault proofs](/operators/chain-operators/tutorials/migrating-permissionless) guide +* Checkout the [migrating to permissionless fault proofs](/operators/chain-operators/tutorials/migrating-permissionless) guide.
231-231: Use title case for page link text.
Link text pointing to a page should be in title case:-[proposer configuration reference](/operators/chain-operators/configuration/proposer) +[Proposer Configuration Reference](/operators/chain-operators/configuration/proposer)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with the following criteria: - First, check the frontmatter section at the top of the file: 1. For regular pages, ensure AL...
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- First, check the frontmatter section at the top of the file:
- For regular pages, ensure ALL these fields are present and not empty:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] personas: [non-empty array] categories: [non-empty array] content_type: [valid type] ---
- For landing pages (index.mdx or files with ), only these fields are required:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] ---
- If any required fields are missing or empty, comment:
'This file appears to be missing required metadata. Please check keywords.config.yaml for valid options and add the required fields manually. You can validate your changes by running:pnpm validate-metadata ```'- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx
🪛 LanguageTool
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx
[grammar] ~23-~23: It appears that a hyphen is missing in the noun “To-do” (= task) or did you mean the verb “to do”?
Context: ...please refer to the [sequencer guide](Todo - Add this link when it's live) first. ...
(TO_DO_HYPHEN)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
- GitHub Check: pr-workflow
🔇 Additional comments (2)
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx (2)
1-17: Frontmatter metadata is complete and valid.
All required fields (title,lang,description,content_type,topic,personas,categories) are present and non-empty.
115-137: Close the.envcode block.
The environment variable snippet is opened with triple backticks but never closed, which will break rendering. Add a closing fence before the "Important" callout:@@ PROPOSER_RPC_PORT=8560 +```Likely an incorrect or invalid review comment.
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx (1)
25-25: Fix the placeholder sequencer guide link.The link uses escaped syntax and a “Todo” placeholder. Replace it with the actual path and correct markdown.
- If you haven't set up your sequencer yet, please refer to the \[sequencer guide]\(Todo - Add this link when it's live) first. + If a sequencer hasn't been set up yet, refer to the [Sequencer setup guide](/operators/chain-operators/deploy/sequencer-setup) first.
🧹 Nitpick comments (3)
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx (3)
19-19: Remove unused import.The
Stepscomponent is imported but not used in this document. Remove it to avoid dead code.- import { Callout, Steps } from 'nextra/components' + import { Callout } from 'nextra/components'
23-23: Avoid first-person pronouns.Use the imperative voice and neutral tone instead of "we".
- After you have spun up your sequencer, you need to attach a proposer to post your L2 state roots data back onto L1 so we can prove withdrawal validity. + After spinning up your sequencer, attach a proposer to post your L2 state roots data back onto L1 to prove withdrawal validity.
262-262: Capitalize action and link text.Use sentence case for the action and title case for the referenced guide.
- * checkout the [migrating to permissionless fault proofs](/operators/chain-operators/tutorials/migrating-permissionless) guide + * Checkout the [Migrating to permissionless fault proofs](/operators/chain-operators/tutorials/migrating-permissionless) guide
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
pages/operators/chain-operators/deploy/_meta.json(1 hunks)pages/operators/chain-operators/deploy/proposer-setup-guide.mdx(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- pages/operators/chain-operators/deploy/_meta.json
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with the following criteria: - First, check the frontmatter section at the top of the file: 1. For regular pages, ensure AL...
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- First, check the frontmatter section at the top of the file:
- For regular pages, ensure ALL these fields are present and not empty:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] personas: [non-empty array] categories: [non-empty array] content_type: [valid type] ---
- For landing pages (index.mdx or files with ), only these fields are required:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] ---
- If any required fields are missing or empty, comment:
'This file appears to be missing required metadata. Please check keywords.config.yaml for valid options and add the required fields manually. You can validate your changes by running:pnpm validate-metadata ```'- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx
🪛 LanguageTool
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx
[grammar] ~25-~25: It appears that a hyphen is missing in the noun “To-do” (= task) or did you mean the verb “to do”?
Context: ...please refer to the [sequencer guide](Todo - Add this link when it's live) first. ...
(TO_DO_HYPHEN)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
- GitHub Check: pr-workflow
🔇 Additional comments (1)
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx (1)
1-17: Frontmatter metadata is complete and valid.All required fields (
title,lang,description,topic,personas,categories,content_type) are present and non-empty.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (3)
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx (3)
23-23: Fix sequencer guide placeholder link
Replace the stray parentheses and placeholder with a proper markdown link to the Sequencer setup guide.- After you have (spun up your sequencer)\[link-to-sequencer-guide], you need to attach a proposer… + After spinning up your sequencer using the [Sequencer setup guide](/operators/chain-operators/deploy/sequencer-setup), attach a proposer…
25-25: Fix broken sequencer guide link and markdown syntax
Remove escape characters and update the placeholder link.- If you haven't set up your sequencer yet, please refer to the \[sequencer guide]\(Todo - Add this link when it's live) first. + If you haven't set up your sequencer yet, please refer to the [Sequencer setup guide](/operators/chain-operators/deploy/sequencer-setup) first.
72-75: Update placeholder link in compatibility callout
Replace the placeholder and remove unnecessary escapes for proper rendering.- This uses `op-proposer/v1.10.0` which is compatible with op-node/v1.13.3 and op-geth/v1.101511.0 from \[spinning up the sequencer guide]\(Will link to this, when its live). + This uses `op-proposer/v1.10.0`, which is compatible with `op-node/v1.13.3` and `op-geth/v1.101511.0` as detailed in the [Sequencer setup guide](/operators/chain-operators/deploy/sequencer-setup).
🧹 Nitpick comments (3)
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx (3)
16-16: Normalizeis_imported_contentto boolean
Frontmatter booleans should be unquoted to ensure correct parsing.- is_imported_content: 'false' + is_imported_content: false
19-19: Remove unusedStepsimport
Stepsis imported but never used in this document.-import { Callout, Steps } from 'nextra/components' +import { Callout } from 'nextra/components'
262-262: Capitalize 'Checkout' in Next steps list
Bullet items should use sentence case (first word capitalized).-* checkout the [migrating to permissionless fault proofs](/operators/chain-operators/tutorials/migrating-permissionless) guide +* Checkout the [migrating to permissionless fault proofs](/operators/chain-operators/tutorials/migrating-permissionless) guide
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with the following criteria: - First, check the frontmatter section at the top of the file: 1. For regular pages, ensure AL...
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- First, check the frontmatter section at the top of the file:
- For regular pages, ensure ALL these fields are present and not empty:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] personas: [non-empty array] categories: [non-empty array] content_type: [valid type] ---
- For landing pages (index.mdx or files with ), only these fields are required:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] ---
- If any required fields are missing or empty, comment:
'This file appears to be missing required metadata. Please check keywords.config.yaml for valid options and add the required fields manually. You can validate your changes by running:pnpm validate-metadata ```'- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx
🪛 LanguageTool
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx
[grammar] ~25-~25: It appears that a hyphen is missing in the noun “To-do” (= task) or did you mean the verb “to do”?
Context: ...please refer to the [sequencer guide](Todo - Add this link when it's live) first. ...
(TO_DO_HYPHEN)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
🔇 Additional comments (3)
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx (3)
1-17: Frontmatter metadata looks complete and valid.
All required fields (title,lang,description,topic,personas,categories,content_type) are present and non-empty.
203-224: Ensure code block is closed for connectivity tests
The JSON-RPC examples open a code block but never close it, breaking markdown. Add closing backticks.@@ curl -X POST ... $ROLLUP_RPC_URL - $ROLLUP_RPC_URL + $ROLLUP_RPC_URL +```Likely an incorrect or invalid review comment.
228-234: Close code block in start-proposer script snippet
The bash snippet forstart-proposer.shmust be closed with ``` to render correctly.@@ chmod +x scripts/start-proposer.sh - ./scripts/start-proposer.sh + ./scripts/start-proposer.sh +```Likely an incorrect or invalid review comment.
There was a problem hiding this comment.
Actionable comments posted: 4
♻️ Duplicate comments (1)
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx (1)
71-74: Callout still contains broken placeholder link (duplicate of prior review)The earlier review pointed out the escaped link; it remains unresolved.
- This uses `op-proposer/v1.10.0` which is compatible with op-node/v1.13.3 and op-geth/v1.101511.0 from \[spinning up the sequencer guide]\(Will link to this, when its live). + This uses `op-proposer/v1.10.0`, compatible with `op-node/v1.13.3` and `op-geth/v1.101511.0` as detailed in the [sequencer setup guide](/operators/chain-operators/deploy/sequencer-setup).
🧹 Nitpick comments (1)
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx (1)
179-180: Avoid first-person commentary in inline code commentsDocumentation should use the imperative mood and avoid “we.”
-# Path to the op-proposer binary we built +# Path to the previously built op-proposer binary
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
pages/operators/chain-operators/deploy/_meta.json(1 hunks)pages/operators/chain-operators/deploy/proposer-setup-guide.mdx(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- pages/operators/chain-operators/deploy/_meta.json
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with the following criteria: - First, check the frontmatter section at the top of the file: 1. For regular pages, ensure AL...
**/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- First, check the frontmatter section at the top of the file:
- For regular pages, ensure ALL these fields are present and not empty:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] personas: [non-empty array] categories: [non-empty array] content_type: [valid type] ---
- For landing pages (index.mdx or files with ), only these fields are required:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] ---
- If any required fields are missing or empty, comment:
'This file appears to be missing required metadata. Please check keywords.config.yaml for valid options and add the required fields manually. You can validate your changes by running:pnpm validate-metadata ```'- Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation.
- Avoid gender-specific language and use the imperative form.
- Monitor capitalization for emphasis. Avoid using all caps, italics, or bold for emphasis.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links.
- Use correct spelling and grammar at all times (IMPORTANT).
- For H1, H2, and H3 headers:
- Use sentence case, capitalizing only the first word.
- Preserve the capitalization of proper nouns, technical terms, and acronyms as defined in the 'nouns.txt' file located in the root directory of the project.
- Do not automatically lowercase words that appear in the 'nouns.txt' file, regardless of their position in the header.
- Flag any headers that seem to inconsistently apply these rules for manual review.
- When reviewing capitalization, always refer to the 'nouns.txt' file for the correct capitalization of proper nouns and technical terms specific to the project.
"
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx
🪛 LanguageTool
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx
[grammar] ~25-~25: It appears that a hyphen is missing in the noun “To-do” (= task) or did you mean the verb “to do”?
Context: ...please refer to the [sequencer guide](Todo - Add this link when it's live) first. ...
(TO_DO_HYPHEN)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
- GitHub Check: pr-workflow
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx
Outdated
Show resolved
Hide resolved
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx
Outdated
Show resolved
Hide resolved
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx
Outdated
Show resolved
Hide resolved
…uration information
…d additional next steps
bradleycamacho
left a comment
bradleycamacho
left a comment
There was a problem hiding this comment.
Just a few comments!
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx
Outdated
Show resolved
Hide resolved
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx
Outdated
Show resolved
Hide resolved
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: Bradley Camacho <42678939+bradleycamacho@users.noreply.github.com>
Co-authored-by: Bradley Camacho <42678939+bradleycamacho@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
words.txt (2)
1-4: Avoid manual duplication of simple case-changesManually adding an UPPER-CASE and Title-Case variant for every existing entry (e.g.
accountqueue/ACCOUNTQUEUE,alphanet/Alphanet/Alphanets) bloats the dictionary and is hard to maintain.
The spell-checker in this repo is already configured to be case-insensitive, so a single lowercase form is enough. Consider keeping only the canonical lowercase tokens and regenerating the file with:-ACCOUNTQUEUE -ACCOUNTSLOTS -Alphanet -Alphanets ...If the current linter really needs explicit variants, we should script their generation instead of committing them by hand to prevent drift.
Also applies to: 11-16
439-444: Possessive entries (Viem's) seldom neededIncluding possessive forms (
Viem's) rarely helps linting and inflates the list. Unless writers are expected to use possessives frequently, consider dropping them.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx(1 hunks)words.txt(9 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- pages/operators/chain-operators/deploy/proposer-setup-guide.mdx
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: qbzzt
PR: ethereum-optimism/docs#1613
File: public/tutorials/attest.mjs:64-71
Timestamp: 2025-05-24T18:24:46.628Z
Learning: For tutorial and educational code in the ethereum-optimism/docs repository, prioritize simplicity and clarity over production-level robustness. Hardcoded values and simplified error handling are acceptable when they help demonstrate core concepts without unnecessary complexity.
Learnt from: sbvegan
PR: ethereum-optimism/docs#1001
File: pages/builders.mdx:11-12
Timestamp: 2024-10-22T02:58:02.175Z
Learning: Prefer using 'OP Stack' over 'OP Mainnet' in documentation for consistency.
Learnt from: qbzzt
PR: ethereum-optimism/docs#1390
File: public/tutorials/CustomSuperchainToken.sol:32-38
Timestamp: 2025-02-20T16:55:42.917Z
Learning: In tutorial and example code for the ethereum-optimism/docs repository, prioritize code clarity and simplicity over additional security measures or optimizations, unless they are specifically part of the learning objectives.
words.txt (1)
Learnt from: sbvegan
PR: ethereum-optimism/docs#1001
File: pages/builders.mdx:11-12
Timestamp: 2024-10-22T02:58:02.175Z
Learning: Prefer using 'OP Stack' over 'OP Mainnet' in documentation for consistency.
🪛 LanguageTool
words.txt
[duplication] ~2-~2: Možný preklep: zopakovali ste slovo
Context: accountqueue ACCOUNTQUEUE accountslots ACCOUNTSLOTS ACDC ADDI ADDIU ADDU airgap Allnodes al...
(WORD_REPEAT_RULE)
[duplication] ~11-~11: Možný preklep: zopakovali ste slovo
Context: ... ADDI ADDIU ADDU airgap Allnodes allocs alphanet Alphanet alphanets Alphanets altda ANDI Ankr Ape...
(WORD_REPEAT_RULE)
[duplication] ~13-~13: Možný preklep: zopakovali ste slovo
Context: ...irgap Allnodes allocs alphanet Alphanet alphanets Alphanets altda ANDI Ankr Apeworx Arweave authrpc...
(WORD_REPEAT_RULE)
[duplication] ~21-~21: Možný preklep: zopakovali ste slovo
Context: ...altda ANDI Ankr Apeworx Arweave authrpc autorelay Autorelay autorelayer basefee bcde betanet Betane...
(WORD_REPEAT_RULE)
[duplication] ~26-~26: Možný preklep: zopakovali ste slovo
Context: ...elay Autorelay autorelayer basefee bcde betanet Betanet betanets Betanets BGEZ BGTZ Biconomy BL...
(WORD_REPEAT_RULE)
[duplication] ~28-~28: Možný preklep: zopakovali ste slovo
Context: ...utorelayer basefee bcde betanet Betanet betanets Betanets BGEZ BGTZ Biconomy BLEZ blobpool BLOBPO...
(WORD_REPEAT_RULE)
[duplication] ~34-~34: Možný preklep: zopakovali ste slovo
Context: ...tanets Betanets BGEZ BGTZ Biconomy BLEZ blobpool BLOBPOOL blobspace Blockdaemon blockhash blockli...
(WORD_REPEAT_RULE)
[duplication] ~40-~40: Možný preklep: zopakovali ste slovo
Context: ...bspace Blockdaemon blockhash blocklists blocklogs BLOCKLOGS blockprofilerate BLOCKPROFILERATE Block...
(WORD_REPEAT_RULE)
[duplication] ~42-~42: Možný preklep: zopakovali ste slovo
Context: ...lockhash blocklists blocklogs BLOCKLOGS blockprofilerate BLOCKPROFILERATE Blockscout blockspace Blockspace blockt...
(WORD_REPEAT_RULE)
[duplication] ~45-~45: Možný preklep: zopakovali ste slovo
Context: ...profilerate BLOCKPROFILERATE Blockscout blockspace Blockspace blocktime blocktimes Blocktimes bloomfi...
(WORD_REPEAT_RULE)
[duplication] ~48-~48: Možný preklep: zopakovali ste slovo
Context: ...ckscout blockspace Blockspace blocktime blocktimes Blocktimes bloomfilter BLOOMFILTER BLTZ Bootcamp b...
(WORD_REPEAT_RULE)
[duplication] ~50-~50: Možný preklep: zopakovali ste slovo
Context: ...ckspace blocktime blocktimes Blocktimes bloomfilter BLOOMFILTER BLTZ Bootcamp bootnode bootnodes Bootno...
(WORD_REPEAT_RULE)
[duplication] ~55-~55: Možný preklep: zopakovali ste slovo
Context: ...lter BLOOMFILTER BLTZ Bootcamp bootnode bootnodes Bootnodes BOOTNODES bottlenecked brotli Brotli ca...
(WORD_REPEAT_RULE)
[duplication] ~59-~59: Možný preklep: zopakovali ste slovo
Context: ...tnodes Bootnodes BOOTNODES bottlenecked brotli Brotli callouts Callouts CCIP cdef Celestia Ce...
(WORD_REPEAT_RULE)
[duplication] ~61-~61: Možný preklep: zopakovali ste slovo
Context: ...es BOOTNODES bottlenecked brotli Brotli callouts Callouts CCIP cdef Celestia Celestia's chainid C...
(WORD_REPEAT_RULE)
[duplication] ~79-~79: Možný preklep: zopakovali ste slovo
Context: ...alized Collateralized compr Comprensive computependingblock COMPUTEPENDINGBLOCK confs corsdomain counterfactually cross...
(WORD_REPEAT_RULE)
[duplication] ~84-~84: Možný preklep: zopakovali ste slovo
Context: ...BLOCK confs corsdomain counterfactually crosschain Crosschain Crossmint daserver datacap DATACAP data...
(WORD_REPEAT_RULE)
[duplication] ~88-~88: Možný preklep: zopakovali ste slovo
Context: ...rosschain Crosschain Crossmint daserver datacap DATACAP datadir DATADIR Defi Defillama's devnet...
(WORD_REPEAT_RULE)
[duplication] ~90-~90: Možný preklep: zopakovali ste slovo
Context: ...hain Crossmint daserver datacap DATACAP datadir DATADIR Defi Defillama's devnet Devnet devnets ...
(WORD_REPEAT_RULE)
[duplication] ~94-~94: Možný preklep: zopakovali ste slovo
Context: ...ATACAP datadir DATADIR Defi Defillama's devnet Devnet devnets Devnets devs direnv disabletxpo...
(WORD_REPEAT_RULE)
[duplication] ~96-~96: Možný preklep: zopakovali ste slovo
Context: ... DATADIR Defi Defillama's devnet Devnet devnets Devnets devs direnv disabletxpoolgossip DISABLE...
(WORD_REPEAT_RULE)
[duplication] ~100-~100: Možný preklep: zopakovali ste slovo
Context: ...vnet Devnet devnets Devnets devs direnv disabletxpoolgossip DISABLETXPOOLGOSSIP discv Discv DIVU Drand dripcheck Drippi...
(WORD_REPEAT_RULE)
[duplication] ~102-~102: Možný preklep: zopakovali ste slovo
Context: ...disabletxpoolgossip DISABLETXPOOLGOSSIP discv Discv DIVU Drand dripcheck Drippie Eigen EIPs...
(WORD_REPEAT_RULE)
[duplication] ~110-~110: Možný preklep: zopakovali ste slovo
Context: ...DIVU Drand dripcheck Drippie Eigen EIPs enabledeprecatedpersonal ENABLEDEPRECATEDPERSONAL enginekind erigon Erigon etherbase ETHE...
(WORD_REPEAT_RULE)
[duplication] ~113-~113: Možný preklep: zopakovali ste slovo
Context: ...nal ENABLEDEPRECATEDPERSONAL enginekind erigon Erigon etherbase ETHERBASE Ethernity Ethernow ...
(WORD_REPEAT_RULE)
[duplication] ~115-~115: Možný preklep: zopakovali ste slovo
Context: ...ECATEDPERSONAL enginekind erigon Erigon etherbase ETHERBASE Ethernity Ethernow ethstats ETHSTATS ev...
(WORD_REPEAT_RULE)
[duplication] ~119-~119: Možný preklep: zopakovali ste slovo
Context: ... etherbase ETHERBASE Ethernity Ethernow ethstats ETHSTATS evmtimeout EVMTIMEOUT executability exf...
(WORD_REPEAT_RULE)
[duplication] ~121-~121: Možný preklep: zopakovali ste slovo
Context: ...SE Ethernity Ethernow ethstats ETHSTATS evmtimeout EVMTIMEOUT executability exfiltrate exitwhensynced...
(WORD_REPEAT_RULE)
[duplication] ~125-~125: Možný preklep: zopakovali ste slovo
Context: ...out EVMTIMEOUT executability exfiltrate exitwhensynced EXITWHENSYNCED extensibly extradata EXTRADATA Farcaste...
(WORD_REPEAT_RULE)
[duplication] ~128-~128: Možný preklep: zopakovali ste slovo
Context: ...xitwhensynced EXITWHENSYNCED extensibly extradata EXTRADATA Farcaster Faultproof fdlimit FDLIMIT Fl...
(WORD_REPEAT_RULE)
[duplication] ~132-~132: Možný preklep: zopakovali ste slovo
Context: ...xtradata EXTRADATA Farcaster Faultproof fdlimit FDLIMIT Flashblocks Flashbots forkable forkchoi...
(WORD_REPEAT_RULE)
[duplication] ~145-~145: Možný preklep: zopakovali ste slovo
Context: ...s Fraxtal Funct gascap GASCAP gaslessly gcmode GCMODE Gelato gifs globalqueue GLOBALQUEUE glo...
(WORD_REPEAT_RULE)
[duplication] ~149-~149: Možný preklep: zopakovali ste slovo
Context: ...CAP gaslessly gcmode GCMODE Gelato gifs globalqueue GLOBALQUEUE globalslots GLOBALSLOTS gokzg growthepi...
(WORD_REPEAT_RULE)
[duplication] ~151-~151: Možný preklep: zopakovali ste slovo
Context: ...ODE Gelato gifs globalqueue GLOBALQUEUE globalslots GLOBALSLOTS gokzg growthepie hardfork hardforks hea...
(WORD_REPEAT_RULE)
[duplication] ~157-~157: Možný preklep: zopakovali ste slovo
Context: ...OTS gokzg growthepie hardfork hardforks healthcheck HEALTHCHECK healthchecks historicalrpc HISTORICALRP...
(WORD_REPEAT_RULE)
[duplication] ~160-~160: Možný preklep: zopakovali ste slovo
Context: ...ks healthcheck HEALTHCHECK healthchecks historicalrpc HISTORICALRPC historicalrpctimeout HISTORICALRPCTIMEO...
(WORD_REPEAT_RULE)
[duplication] ~162-~162: Možný preklep: zopakovali ste slovo
Context: ...ealthchecks historicalrpc HISTORICALRPC historicalrpctimeout HISTORICALRPCTIMEOUT holesky Holesky HOLESKY IERC ignorepric...
(WORD_REPEAT_RULE)
[duplication] ~164-~164: Možný preklep: zopakovali ste slovo
Context: ...storicalrpctimeout HISTORICALRPCTIMEOUT holesky Holesky HOLESKY IERC ignoreprice IGNOREPRICE Im...
(WORD_REPEAT_RULE)
[duplication] ~168-~168: Možný preklep: zopakovali ste slovo
Context: ...RPCTIMEOUT holesky Holesky HOLESKY IERC ignoreprice IGNOREPRICE Immunefi inator Inator influxdbv INFLUX...
(WORD_REPEAT_RULE)
[duplication] ~171-~171: Možný preklep: zopakovali ste slovo
Context: ...Y IERC ignoreprice IGNOREPRICE Immunefi inator Inator influxdbv INFLUXDBV initcode ipcdisable...
(WORD_REPEAT_RULE)
[duplication] ~173-~173: Možný preklep: zopakovali ste slovo
Context: ...rice IGNOREPRICE Immunefi inator Inator influxdbv INFLUXDBV initcode ipcdisable IPCDISABLE ipcfile ...
(WORD_REPEAT_RULE)
[duplication] ~176-~176: Možný preklep: zopakovali ste slovo
Context: ...tor Inator influxdbv INFLUXDBV initcode ipcdisable IPCDISABLE ipcfile ipcpath IPCPATH IPFS JALR journ...
(WORD_REPEAT_RULE)
[duplication] ~179-~179: Možný preklep: zopakovali ste slovo
Context: ... initcode ipcdisable IPCDISABLE ipcfile ipcpath IPCPATH IPFS JALR journalremotes JOURNALREMOTES...
(WORD_REPEAT_RULE)
[duplication] ~183-~183: Možný preklep: zopakovali ste slovo
Context: ...SABLE ipcfile ipcpath IPCPATH IPFS JALR journalremotes JOURNALREMOTES jspath JSPATH jwtsecret Keccak leveldb ...
(WORD_REPEAT_RULE)
[duplication] ~185-~185: Možný preklep: zopakovali ste slovo
Context: ...IPFS JALR journalremotes JOURNALREMOTES jspath JSPATH jwtsecret Keccak leveldb lightkdf Lisk ...
(WORD_REPEAT_RULE)
[duplication] ~197-~197: Možný preklep: zopakovali ste slovo
Context: ...k logfile logfmt Mainnets maxage MAXAGE maxbackups MAXBACKUPS maxpeers MAXPEERS maxpendpeers MAXPENDP...
(WORD_REPEAT_RULE)
[duplication] ~199-~199: Možný preklep: zopakovali ste slovo
Context: ...ets maxage MAXAGE maxbackups MAXBACKUPS maxpeers MAXPEERS maxpendpeers MAXPENDPEERS maxprice MAXP...
(WORD_REPEAT_RULE)
[duplication] ~201-~201: Možný preklep: zopakovali ste slovo
Context: ...maxbackups MAXBACKUPS maxpeers MAXPEERS maxpendpeers MAXPENDPEERS maxprice MAXPRICE memprofilerate MEMPRO...
(WORD_REPEAT_RULE)
[duplication] ~203-~203: Možný preklep: zopakovali ste slovo
Context: ...eers MAXPEERS maxpendpeers MAXPENDPEERS maxprice MAXPRICE memprofilerate MEMPROFILERATE merkle Me...
(WORD_REPEAT_RULE)
[duplication] ~205-~205: Možný preklep: zopakovali ste slovo
Context: ...endpeers MAXPENDPEERS maxprice MAXPRICE memprofilerate MEMPROFILERATE merkle Merkle MFHI MFLO Mgas Minato min...
(WORD_REPEAT_RULE)
[duplication] ~207-~207: Možný preklep: zopakovali ste slovo
Context: ... MAXPRICE memprofilerate MEMPROFILERATE merkle Merkle MFHI MFLO Mgas Minato minfreedisk MINFR...
(WORD_REPEAT_RULE)
[duplication] ~213-~213: Možný preklep: zopakovali ste slovo
Context: ...ATE merkle Merkle MFHI MFLO Mgas Minato minfreedisk MINFREEDISK minsuggestedpriorityfee MINSUGGESTEDPRI...
(WORD_REPEAT_RULE)
[duplication] ~215-~215: Možný preklep: zopakovali ste slovo
Context: ...FLO Mgas Minato minfreedisk MINFREEDISK minsuggestedpriorityfee MINSUGGESTEDPRIORITYFEE Mintable Mintplex MIPSEVM Mitigations m...
(WORD_REPEAT_RULE)
[duplication] ~221-~221: Možný preklep: zopakovali ste slovo
Context: ...E Mintable Mintplex MIPSEVM Mitigations monitorism Monitorism Moralis Mordor mountpoint MOVN MOVZ MTH...
(WORD_REPEAT_RULE)
[duplication] ~238-~238: Možný preklep: zopakovali ste slovo
Context: ... multiclient multisigs MULTU nethermind netrestrict NETRESTRICT networkid NETWORKID newpayload NEWPAYLO...
(WORD_REPEAT_RULE)
[duplication] ~240-~240: Možný preklep: zopakovali ste slovo
Context: ...ULTU nethermind netrestrict NETRESTRICT networkid NETWORKID newpayload NEWPAYLOAD nextra nocompacti...
(WORD_REPEAT_RULE)
[duplication] ~242-~242: Možný preklep: zopakovali ste slovo
Context: ...estrict NETRESTRICT networkid NETWORKID newpayload NEWPAYLOAD nextra nocompaction NOCOMPACTION nodeke...
(WORD_REPEAT_RULE)
[duplication] ~245-~245: Možný preklep: zopakovali ste slovo
Context: ... NETWORKID newpayload NEWPAYLOAD nextra nocompaction NOCOMPACTION nodekey NODEKEY nodekeyhex NODEKEYHEX n...
(WORD_REPEAT_RULE)
[duplication] ~247-~247: Možný preklep: zopakovali ste slovo
Context: ...AYLOAD nextra nocompaction NOCOMPACTION nodekey NODEKEY nodekeyhex NODEKEYHEX nodename Nodies n...
(WORD_REPEAT_RULE)
[duplication] ~249-~249: Možný preklep: zopakovali ste slovo
Context: ...compaction NOCOMPACTION nodekey NODEKEY nodekeyhex NODEKEYHEX nodename Nodies nodiscover NODISCOVER n...
(WORD_REPEAT_RULE)
[duplication] ~253-~253: Možný preklep: zopakovali ste slovo
Context: ...Y nodekeyhex NODEKEYHEX nodename Nodies nodiscover NODISCOVER nolocals NOLOCALS noprefetch NOPREFETCH...
(WORD_REPEAT_RULE)
[duplication] ~255-~255: Možný preklep: zopakovali ste slovo
Context: ...X nodename Nodies nodiscover NODISCOVER nolocals NOLOCALS noprefetch NOPREFETCH nopruning NOPRUNI...
(WORD_REPEAT_RULE)
[duplication] ~257-~257: Možný preklep: zopakovali ste slovo
Context: ...nodiscover NODISCOVER nolocals NOLOCALS noprefetch NOPREFETCH nopruning NOPRUNING nosyncserve NOSYNCS...
(WORD_REPEAT_RULE)
[duplication] ~259-~259: Možný preklep: zopakovali ste slovo
Context: ...nolocals NOLOCALS noprefetch NOPREFETCH nopruning NOPRUNING nosyncserve NOSYNCSERVE Numba NVME offc...
(WORD_REPEAT_RULE)
[duplication] ~261-~261: Možný preklep: zopakovali ste slovo
Context: ...prefetch NOPREFETCH nopruning NOPRUNING nosyncserve NOSYNCSERVE Numba NVME offchain Offchain opchaina o...
(WORD_REPEAT_RULE)
[duplication] ~265-~265: Možný preklep: zopakovali ste slovo
Context: ...NING nosyncserve NOSYNCSERVE Numba NVME offchain Offchain opchaina opchainb opcm OPCM Openfort op...
(WORD_REPEAT_RULE)
[duplication] ~269-~269: Možný preklep: zopakovali ste slovo
Context: ...VME offchain Offchain opchaina opchainb opcm OPCM Openfort oplabs opnode's outfile outper...
(WORD_REPEAT_RULE)
[duplication] ~277-~277: Možný preklep: zopakovali ste slovo
Context: ...node's outfile outperformance pcscdpath pectra Pectra Pectra's peerstore Peerstore peerstores...
(WORD_REPEAT_RULE)
[duplication] ~280-~280: Možný preklep: zopakovali ste slovo
Context: ...rmance pcscdpath pectra Pectra Pectra's peerstore Peerstore peerstores permissioned Permissioned pe...
(WORD_REPEAT_RULE)
[duplication] ~283-~283: Možný preklep: zopakovali ste slovo
Context: ...Pectra's peerstore Peerstore peerstores permissioned Permissioned permissioning permissionless Permission...
(WORD_REPEAT_RULE)
[duplication] ~286-~286: Možný preklep: zopakovali ste slovo
Context: ...permissioned Permissioned permissioning permissionless Permissionless permissionlessly Perps Peta Pimlico POA...
(WORD_REPEAT_RULE)
[duplication] ~294-~294: Možný preklep: zopakovali ste slovo
Context: ...ionlessly Perps Peta Pimlico POAP POAPs pprof PPROF precommitments Precommitments preconfig...
(WORD_REPEAT_RULE)
[duplication] ~296-~296: Možný preklep: zopakovali ste slovo
Context: ...rps Peta Pimlico POAP POAPs pprof PPROF precommitments Precommitments preconfigured predeploy predeployed Pre...
(WORD_REPEAT_RULE)
[duplication] ~300-~300: Možný preklep: zopakovali ste slovo
Context: ... Precommitments preconfigured predeploy predeployed Predeployed predeploys Predeploys prefunded preimag...
(WORD_REPEAT_RULE)
[duplication] ~302-~302: Možný preklep: zopakovali ste slovo
Context: ...gured predeploy predeployed Predeployed predeploys Predeploys prefunded preimage Preimage preimages P...
(WORD_REPEAT_RULE)
[duplication] ~305-~305: Možný preklep: zopakovali ste slovo
Context: ...eployed predeploys Predeploys prefunded preimage Preimage preimages PREIMAGES preinstall preinsta...
(WORD_REPEAT_RULE)
[duplication] ~307-~307: Možný preklep: zopakovali ste slovo
Context: ... Predeploys prefunded preimage Preimage preimages PREIMAGES preinstall preinstalls Preinstalls pres...
(WORD_REPEAT_RULE)
[duplication] ~310-~310: Možný preklep: zopakovali ste slovo
Context: ...Preimage preimages PREIMAGES preinstall preinstalls Preinstalls prestate Prestate prestates PREVRANDAO ...
(WORD_REPEAT_RULE)
[duplication] ~312-~312: Možný preklep: zopakovali ste slovo
Context: ...AGES preinstall preinstalls Preinstalls prestate Prestate prestates PREVRANDAO pricebump PRICEBUM...
(WORD_REPEAT_RULE)
[duplication] ~316-~316: Možný preklep: zopakovali ste slovo
Context: ... prestate Prestate prestates PREVRANDAO pricebump PRICEBUMP pricelimit PRICELIMIT productionize pro...
(WORD_REPEAT_RULE)
[duplication] ~318-~318: Možný preklep: zopakovali ste slovo
Context: ...restates PREVRANDAO pricebump PRICEBUMP pricelimit PRICELIMIT productionize productionized Protip Pro...
(WORD_REPEAT_RULE)
[duplication] ~324-~324: Možný preklep: zopakovali ste slovo
Context: ...uctionize productionized Protip Proxied proxyd Proxyd Pyth Pyth's QRNG quicknode Quicknode qu...
(WORD_REPEAT_RULE)
[duplication] ~326-~326: Možný preklep: zopakovali ste slovo
Context: ...uctionized Protip Proxied proxyd Proxyd Pyth Pyth's QRNG quicknode Quicknode quickstarts ...
(WORD_REPEAT_RULE)
[duplication] ~329-~329: Možný preklep: zopakovali ste slovo
Context: ... Proxied proxyd Proxyd Pyth Pyth's QRNG quicknode Quicknode quickstarts rebalancing reemit Reemitti...
(WORD_REPEAT_RULE)
[duplication] ~335-~335: Možný preklep: zopakovali ste slovo
Context: ...ickstarts rebalancing reemit Reemitting regenesis Regenesis Reimagine rejournal REJOURNAL remotedb ...
(WORD_REPEAT_RULE)
[duplication] ~338-~338: Možný preklep: zopakovali ste slovo
Context: ...eemitting regenesis Regenesis Reimagine rejournal REJOURNAL remotedb REMOTEDB Reown Reown's replaya...
(WORD_REPEAT_RULE)
[duplication] ~340-~340: Možný preklep: zopakovali ste slovo
Context: ...Regenesis Reimagine rejournal REJOURNAL remotedb REMOTEDB Reown Reown's replayability replayor re...
(WORD_REPEAT_RULE)
[duplication] ~342-~342: Možný preklep: zopakovali ste slovo
Context: ...e rejournal REJOURNAL remotedb REMOTEDB Reown Reown's replayability replayor reposts reprov...
(WORD_REPEAT_RULE)
[duplication] ~348-~348: Možný preklep: zopakovali ste slovo
Context: ...replayability replayor reposts reproven requiredblocks REQUIREDBLOCKS rollouts rollups Rollups Routescan rpck...
(WORD_REPEAT_RULE)
[duplication] ~351-~351: Možný preklep: zopakovali ste slovo
Context: ... requiredblocks REQUIREDBLOCKS rollouts rollups Rollups Routescan rpckind rpcprefix RPCPREFIX r...
(WORD_REPEAT_RULE)
[duplication] ~355-~355: Možný preklep: zopakovali ste slovo
Context: ...louts rollups Rollups Routescan rpckind rpcprefix RPCPREFIX rpcs RPGF runbooks Runbooks RWAs safedb...
(WORD_REPEAT_RULE)
[duplication] ~359-~359: Možný preklep: zopakovali ste slovo
Context: ...n rpckind rpcprefix RPCPREFIX rpcs RPGF runbooks Runbooks RWAs safedb Schnorr sepolia Sepolia SEP...
(WORD_REPEAT_RULE)
[duplication] ~364-~364: Možný preklep: zopakovali ste slovo
Context: ...F runbooks Runbooks RWAs safedb Schnorr sepolia Sepolia SEPOLIA seqnr sequencerhttp SEQUENCERHT...
(WORD_REPEAT_RULE)
[duplication] ~368-~368: Možný preklep: zopakovali ste slovo
Context: ...b Schnorr sepolia Sepolia SEPOLIA seqnr sequencerhttp SEQUENCERHTTP serv signup SLLV SLTI SLTIU SLTU smartc...
(WORD_REPEAT_RULE)
[duplication] ~386-~386: Možný preklep: zopakovali ste slovo
Context: ...olana Soneium soyboy Spearbit SRAV SRLV stablecoins Stablecoins statefulset structs subcomponents subga...
(WORD_REPEAT_RULE)
[duplication] ~398-~398: Možný preklep: zopakovali ste slovo
Context: ...nd SUBU Sunnyside superchain Superchain SUPERCHAIN Superchain's superchainerc Superlend Superloans Su...
(WORD_REPEAT_RULE)
[duplication] ~405-~405: Možný preklep: zopakovali ste slovo
Context: ...uperlend Superloans Superscan Superseed supersim Supersim syncmode SYNCMODE synctarget SYNCTARGET...
(WORD_REPEAT_RULE)
[duplication] ~407-~407: Možný preklep: zopakovali ste slovo
Context: ...s Superscan Superseed supersim Supersim syncmode SYNCMODE synctarget SYNCTARGET syscalls SYSCON t...
(WORD_REPEAT_RULE)
[duplication] ~409-~409: Možný preklep: zopakovali ste slovo
Context: ...eed supersim Supersim syncmode SYNCMODE synctarget SYNCTARGET syscalls SYSCON thirdweb threadcreate t...
(WORD_REPEAT_RULE)
[duplication] ~438-~438: Možný preklep: zopakovali ste slovo
Context: ...ubmitted UPNP upstreaming verkle VERKLE vhosts VHOSTS viem Viem viem's Viem's vmdebug VMDEBUG...
(WORD_REPEAT_RULE)
[duplication] ~440-~440: Možný preklep: zopakovali ste slovo
Context: ...upstreaming verkle VERKLE vhosts VHOSTS viem Viem viem's Viem's vmdebug VMDEBUG vmodule V...
(WORD_REPEAT_RULE)
[duplication] ~444-~444: Možný preklep: zopakovali ste slovo
Context: ...E vhosts VHOSTS viem Viem viem's Viem's vmdebug VMDEBUG vmodule VMODULE xlarge XORI ZKPs ZKVM z...
(WORD_REPEAT_RULE)
[duplication] ~446-~446: Možný preklep: zopakovali ste slovo
Context: ...viem Viem viem's Viem's vmdebug VMDEBUG vmodule VMODULE xlarge XORI ZKPs ZKVM zora Zora
(WORD_REPEAT_RULE)
[duplication] ~452-~452: Možný preklep: zopakovali ste slovo
Context: ...G vmodule VMODULE xlarge XORI ZKPs ZKVM zora Zora
(WORD_REPEAT_RULE)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
- GitHub Check: pr-workflow
🔇 Additional comments (2)
words.txt (2)
147-151: Check alphabetical ordering rule before mergingA handful of newly-added upper-case entries (
GLOBALQUEUE,GLOBALSLOTS, …) now appear after their lower-case counterparts.
If the CI job that verifieswords.txtuses ASCII ordering (whereA < a) this will fail the sort check. Runsort -clocally or invoke the repo’smake lint-wordstarget to confirm.
257-262:NOPRUNINGspelling is correct – ignore LanguageTool FPLanguageTool flags “zopakovali ste slovo” here, but
nopruning/NOPRUNINGis the canonical flag name in Geth. Safe to keep.
Description
This PR creates a new tutorial guide for chain operators to spin up their proposer after setting up their sequencer.
Key Additions
poll-interval,proposal-interval, andnum-confirmationsDisputeGameFactoryapproach.Tests
Additional context
Metadata