-
Notifications
You must be signed in to change notification settings - Fork 270
Proposer setup guide #1645
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Proposer setup guide #1645
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Warning Rate limit exceeded@krofax has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 1 minutes and 28 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughThis set of changes introduces a new comprehensive tutorial for setting up an OP Stack proposer, including prerequisites, configuration steps, and operational guidance. The deployment landing page and its metadata are updated to reference this new proposer setup guide. Several documentation pages are revised to improve clarity, update or add "Next Steps" sections with relevant links, and enhance the organization of related resources. The batcher configuration documentation receives an updated URL for the multi-blob transaction calculator without other content changes. No code or exported/public entities are altered; all modifications are limited to documentation. Sequence Diagram(s)sequenceDiagram
participant Operator
participant Docs Site
participant Proposer
participant L1
participant L2
participant DisputeGameFactory
Operator->>Docs Site: Access "Spin up your proposer" tutorial
Operator->>Proposer: Configure and start proposer using guide
Proposer->>L2: Connect to sequencer node
Proposer->>L1: Connect to L1 via RPC
Proposer->>DisputeGameFactory: Interact for dispute games
Proposer->>L1: Post L2 state roots
Proposer->>Operator: Provide status/logs
Operator->>L1: Monitor dispute games and proposer activity
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
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.1
or later * Enable theminer
API 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 the
OP_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 Steps
to:
## Next steps
pages/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.mdx
pages/operators/chain-operators/tutorials/absolute-prestate.mdx
pages/operators/chain-operators/tutorials/dispute-games.mdx
pages/operators/chain-operators/configuration/batcher.mdx
pages/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 the
OP_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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
|
||
* **State commitment**: Proposing L2 state roots to L1 at regular intervals | ||
* **Withdrawal enablement**: Providing the necessary commitments for users to prove and finalize withdrawals | ||
* **Data availability**: Ensuring L2 state transitions are verifiable from L1 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can delete this, this is the batcher's job
|
||
### Essential parameters | ||
|
||
| Parameter | Recommended Value | Description | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These need to be updated based on my config review values. I can make a commit to get these updated
Description=OP Stack Proposer | ||
After=network.target | ||
|
||
[Service] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I updated a couple of the values below based on my config review
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
The proposer (`op-proposer`) serves as a crucial bridge between your L2 chain and L1 Ethereum. Its primary responsibilities include: | ||
|
||
* **State commitment**: Proposing L2 state roots to L1 at regular intervals | ||
* **Withdrawal enablement**: Providing the necessary commitments for users to prove and finalize withdrawalsz |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix typo in withdrawal description
There’s an extraneous “z” at the end of “withdrawalsz.”
- * **Withdrawal enablement**: Providing the necessary commitments for users to prove and finalize withdrawalsz
+ * **Withdrawal enablement**: Providing the necessary commitments for users to prove and finalize withdrawals
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
* **Withdrawal enablement**: Providing the necessary commitments for users to prove and finalize withdrawalsz | |
* **Withdrawal enablement**: Providing the necessary commitments for users to prove and finalize withdrawals |
🤖 Prompt for AI Agents
In pages/operators/chain-operators/tutorials/proposer-setup-guide.mdx at line
34, remove the extraneous "z" at the end of the word "withdrawalsz" to correct
the typo and make it "withdrawals."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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_DURATION
for 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.mdx
pages/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
<Callout type="info"> | ||
This guide assumes you already have a functioning sequencer and the necessary [L1 contracts deployed](/operators/chain-operators/deploy/overview). | ||
If you haven't set up your sequencer yet, please refer to the \[sequencer guide]\(Todo - Add a link to the spining up your sequencer) first. | ||
</Callout> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Broken placeholder link and escaped syntax. The callout’s sequencer guide link is still a placeholder and uses incorrect escape characters. Replace it with a valid Markdown link and correct spelling.
<Callout type="info">
- This guide assumes you already have a functioning sequencer and the necessary [L1 contracts deployed](/operators/chain-operators/deploy/overview).
- If you haven't set up your sequencer yet, please refer to the \[sequencer guide]\(Todo - Add a link to the spining up your sequencer) first.
+ This guide assumes a functioning sequencer and the necessary [L1 contracts deployed](/operators/chain-operators/deploy/overview).
+ If a sequencer hasn't been set up yet, refer to the [sequencer setup guide](/operators/chain-operators/deploy/sequencer-setup) first.
</Callout>
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
<Callout type="info"> | |
This guide assumes you already have a functioning sequencer and the necessary [L1 contracts deployed](/operators/chain-operators/deploy/overview). | |
If you haven't set up your sequencer yet, please refer to the \[sequencer guide]\(Todo - Add a link to the spining up your sequencer) first. | |
</Callout> | |
<Callout type="info"> | |
This guide assumes a functioning sequencer and the necessary [L1 contracts deployed](/operators/chain-operators/deploy/overview). | |
If a sequencer hasn't been set up yet, refer to the [sequencer setup guide](/operators/chain-operators/deploy/sequencer-setup) first. | |
</Callout> |
🤖 Prompt for AI Agents
In pages/operators/chain-operators/deploy/proposer-setup-guide.mdx around lines
26 to 29, the sequencer guide link is a broken placeholder with incorrect escape
characters and a spelling mistake in "spining." Replace the placeholder with the
correct URL for the sequencer guide, fix the Markdown link syntax by removing
unnecessary escape characters, and correct the spelling to "spinning."
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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: tutorial
is valid.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.json
live" 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.env
code 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (4)
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx (4)
19-20
: Remove unused import. TheSteps
component is imported but never used. Please remove it to avoid an unused import warning.-import { Callout, Steps } from 'nextra/components' +import { Callout } from 'nextra/components'
25-25
: Fix placeholder sequencer guide link. Replace the escaped placeholder with a valid link and remove escape characters. For example:-… please refer to the \[sequencer guide]\(Todo - Add this link when it's live) first. +… please refer to the [sequencer setup guide](/operators/chain-operators/deploy/sequencer-setup) first.
73-73
: Fix placeholder link in callout. Swap out the escaped placeholder for a proper link to the sequencer guide. For example:- This uses `op-proposer/v1.10.0` … from \[spinning up the sequencer guide]\(Will link to this, when its live). + This uses `op-proposer/v1.10.0` … from the [spinning up the sequencer guide](/operators/chain-operators/deploy/sequencer-setup).
262-262
: Capitalize and correct bullet text. Use sentence case and proper phrasing 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.
📜 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 (1)
- GitHub Check: pr-workflow
🔇 Additional comments (1)
pages/operators/chain-operators/deploy/proposer-setup-guide.mdx (1)
1-17
: Frontmatter meets metadata requirements. All required fields (title
,lang
,description
,content_type
,topic
,personas
,categories
) are present and non-empty. Metadata validation should pass.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
Steps
component 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.
<Callout type="info"> | ||
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). | ||
Always check the [release notes](https://github.com/ethereum-optimism/optimism/releases) for compatibility. | ||
</Callout> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Correct callout link and syntax.
The callout contains a broken placeholder link and unnecessary escapes. Update to reference the Sequencer setup guide and fix formatting.
- <Callout type="info">
- 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).
- Always check the [release notes](https://github.com/ethereum-optimism/optimism/releases) for compatibility.
- </Callout>
+ <Callout type="info">
+ 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).
+ Always check the [release notes](https://github.com/ethereum-optimism/optimism/releases) for compatibility.
+ </Callout>
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
<Callout type="info"> | |
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). | |
Always check the [release notes](https://github.com/ethereum-optimism/optimism/releases) for compatibility. | |
</Callout> | |
<Callout type="info"> | |
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). | |
Always check the [release notes](https://github.com/ethereum-optimism/optimism/releases) for compatibility. | |
</Callout> |
🤖 Prompt for AI Agents
In pages/operators/chain-operators/deploy/proposer-setup-guide.mdx around lines
72 to 75, the callout contains a broken placeholder link and unnecessary escape
characters. Replace the placeholder link text with the correct URL or relative
path to the Sequencer setup guide, remove the backslashes before the brackets,
and ensure the markdown link syntax is correct for proper rendering.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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_content
to boolean
Frontmatter booleans should be unquoted to ensure correct parsing.- is_imported_content: 'false' + is_imported_content: false
19-19
: Remove unusedSteps
import
Steps
is 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.sh
must 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.
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-confirmations
DisputeGameFactory
approach.Tests
Additional context
Metadata