-
Notifications
You must be signed in to change notification settings - Fork 262
Sb/pectra u12a update #1490
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
Sb/pectra u12a update #1490
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThis pull request updates documentation related to the Pectra upgrade. A warning callout has been added in the Possibly related PRs
Suggested labels
Suggested reviewers
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked 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: 1
🧹 Nitpick comments (6)
words.txt (3)
176-176
: Spelling Correction Needed: "instuctions" appears to be a typo.
It is recommended to change "instuctions" to "instructions" to maintain consistency in terminology.🧰 Tools
🪛 LanguageTool
[duplication] ~176-~176: Možný preklep: zopakovali ste slovo
Context: ...NFLUXDBV influxdbv initcode instuctions IPCDISABLE ipcdisable ipcfile IPCPATH ipcpath IPFS JALR JOURN...(WORD_REPEAT_RULE)
320-322
: Potential Redundancy in Variant Spellings.
The entries "Proxied", "Proxyd", and "proxyd" appear very similar. Please verify if all three variations are required or if this might be an unintended duplication.🧰 Tools
🪛 LanguageTool
[duplication] ~320-~320: Možný preklep: zopakovali ste slovo
Context: ...uctionize productionized Protip Proxied Proxyd proxyd Pyth Pyth's QRNG Quicknode quicknode qu...(WORD_REPEAT_RULE)
[duplication] ~322-~322: Možný preklep: zopakovali ste slovo
Context: ...uctionized Protip Proxied Proxyd proxyd Pyth Pyth's QRNG Quicknode quicknode quickstarts ...(WORD_REPEAT_RULE)
358-360
: Inconsistent Casing for "SEPOLIA".
There are three variants provided: "SEPOLIA", "Sepolia", and "sepolia". Typically, the convention in this file is to include uppercase and lowercase versions. Please verify whether all three are necessary or if this is an inadvertent duplication.pages/notices/pectra-changes.mdx (3)
22-28
: Grammar and Spelling Corrections in Warning Callout.
- In line 25, remove the comma before "because" and update "overcharge" to "overcharged" for grammatical accuracy.
- In line 27, correct "instuctions" to "instructions."
Example diff:
- This is not a critical issue on any OP Sepolia chain. However, when L1 blob base fees rise to 100 Mwei or higher on Sepolia, there is a temporary liveness risk, because we'd be overcharge L1 fees. + This is not a critical issue on any OP Sepolia chain. However, when L1 blob base fees rise to 100 Mwei or higher on Sepolia, there is a temporary liveness risk because we'd be overcharged L1 fees. - There are new instuctions in the node operator section to help you mitigate this issue. + There are new instructions in the node operator section to help you mitigate this issue.🧰 Tools
🪛 LanguageTool
[formatting] ~25-~25: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...olia, there is a temporary liveness risk, because we'd be overcharge L1 fees. Essentially...(COMMA_BEFORE_BECAUSE)
[grammar] ~25-~25: Consider using either the past participle “overcharged” or the present participle “overcharging” here.
Context: ...emporary liveness risk, because we'd be overcharge L1 fees. Essentially, our L1 cost compu...(BEEN_PART_AGREEMENT)
77-80
: Clarify Node Operators Instruction.
The sentence "For node operators of not included in the [hardfork activation inheritance behavior]..." is confusing. Consider rephrasing it to:
"For node operators not included in the hardfork activation inheritance behavior, you will need to manually configure the activation."
107-107
: Punctuation Improvement in Fault Proof Section.
Add a comma after "permissioned games" to improve readability.
Example diff:-For chains running the Fault Proof System with permissioned games you can skip this section because games will not be played out and the absolute prestate is not used. +For chains running the Fault Proof System with permissioned games, you can skip this section because games will not be played out and the absolute prestate is not used.🧰 Tools
🪛 LanguageTool
[uncategorized] ~107-~107: Possible missing comma found.
Context: ...he Fault Proof System with permissioned games you can skip this section because games...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
pages/notices/pectra-changes.mdx
(5 hunks)words.txt
(4 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with ...
**/*.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. You can fix this by running:Review the changes, then run without :dry to apply them.'pnpm metadata-batch-cli:dry "path/to/this/file.mdx"
- 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/notices/pectra-changes.mdx
🪛 LanguageTool
words.txt
[duplication] ~176-~176: Možný preklep: zopakovali ste slovo
Context: ...NFLUXDBV influxdbv initcode instuctions IPCDISABLE ipcdisable ipcfile IPCPATH ipcpath IPFS JALR JOURN...
(WORD_REPEAT_RULE)
[duplication] ~244-~244: Možný preklep: zopakovali ste slovo
Context: ... networkid NEWPAYLOAD newpayload nextra NOCOMPACTION nocompaction NODEKEY nodekey NODEKEYHEX nodekeyhex n...
(WORD_REPEAT_RULE)
[duplication] ~320-~320: Možný preklep: zopakovali ste slovo
Context: ...uctionize productionized Protip Proxied Proxyd proxyd Pyth Pyth's QRNG Quicknode quicknode qu...
(WORD_REPEAT_RULE)
[duplication] ~322-~322: Možný preklep: zopakovali ste slovo
Context: ...uctionized Protip Proxied Proxyd proxyd Pyth Pyth's QRNG Quicknode quicknode quickstarts ...
(WORD_REPEAT_RULE)
[duplication] ~352-~352: 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] ~357-~357: Možný preklep: zopakovali ste slovo
Context: ...F Runbooks runbooks RWAs safedb Schnorr SEPOLIA Sepolia sepolia seqnr SEQUENCERHTTP sequencerht...
(WORD_REPEAT_RULE)
pages/notices/pectra-changes.mdx
[formatting] ~25-~25: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...olia, there is a temporary liveness risk, because we'd be overcharge L1 fees. Essentially...
(COMMA_BEFORE_BECAUSE)
[grammar] ~25-~25: Consider using either the past participle “overcharged” or the present participle “overcharging” here.
Context: ...emporary liveness risk, because we'd be overcharge L1 fees. Essentially, our L1 cost compu...
(BEEN_PART_AGREEMENT)
[uncategorized] ~73-~73: This looks wrong. Consider replacing it.
Context: ...t release. * op-node
at v1.
* op-geth
at v1.
* op-reth
at [v1.2.0
]...
(AI_EN_LECTOR_REPLACEMENT_SPACE)
[uncategorized] ~107-~107: Possible missing comma found.
Context: ...he Fault Proof System with permissioned games you can skip this section because games...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ 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)
words.txt (2)
244-244
: Verify Term Usage: "nextra".
Ensure that the addition of "nextra" is intentional and that its casing aligns with the project’s conventions. If it’s a reinstated term, consider adding a brief note on its purpose.🧰 Tools
🪛 LanguageTool
[duplication] ~244-~244: Možný preklep: zopakovali ste slovo
Context: ... networkid NEWPAYLOAD newpayload nextra NOCOMPACTION nocompaction NODEKEY nodekey NODEKEYHEX nodekeyhex n...(WORD_REPEAT_RULE)
351-351
: Confirm Term "rpcs".
The new entry "rpcs" seems appropriate given similar acronyms in the file. Please confirm that its inclusion and lowercase form follow the project standards.pages/notices/pectra-changes.mdx (1)
1-16
: Frontmatter Validation.
The frontmatter section is complete with all required fields (title, description, lang, content_type, topic, personas, and categories) correctly filled out.
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/notices/pectra-changes.mdx (2)
22-28
: Improve warning callout language and grammar.
Within the warning callout, consider revising a couple of phrases for clarity and correctness:
- Change “overcharge” to “overcharged” (or “overcharging”) so that the sentence reads smoothly (e.g. “…because we'd be overcharged for L1 fees”).
- Fix the typo “instuctions” to “instructions”.
- This is not a critical issue on any OP Sepolia chain. However, when L1 blob base fees rise to 100 Mwei or higher on Sepolia, there is a temporary liveness risk, because we'd be overcharge L1 fees. + This is not a critical issue on any OP Sepolia chain. However, when L1 blob base fees rise to 100 Mwei or higher on Sepolia, there is a temporary liveness risk because we'd be overcharged for L1 fees. - There are new instuctions in the node operator section to help you mitigate this issue. + There are new instructions in the node operator section to help you mitigate this issue.🧰 Tools
🪛 LanguageTool
[formatting] ~25-~25: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...olia, there is a temporary liveness risk, because we'd be overcharge L1 fees. Essentially...(COMMA_BEFORE_BECAUSE)
[grammar] ~25-~25: Consider using either the past participle “overcharged” or the present participle “overcharging” here.
Context: ...emporary liveness risk, because we'd be overcharge L1 fees. Essentially, our L1 cost compu...(BEEN_PART_AGREEMENT)
105-107
: Enhance punctuation in the fault proof section.
In the sentence describing chains running the Fault Proof System with permissioned games, a comma is needed after “permissioned games” to improve readability. For example:“…For chains running the Fault Proof System with permissioned games, you can skip this section because games will not be played out…”
🧰 Tools
🪛 LanguageTool
[uncategorized] ~107-~107: Possible missing comma found.
Context: ...he Fault Proof System with permissioned games you can skip this section because games...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/notices/pectra-changes.mdx
(5 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with ...
**/*.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. You can fix this by running:Review the changes, then run without :dry to apply them.'pnpm metadata-batch-cli:dry "path/to/this/file.mdx"
- 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/notices/pectra-changes.mdx
🪛 LanguageTool
pages/notices/pectra-changes.mdx
[formatting] ~25-~25: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...olia, there is a temporary liveness risk, because we'd be overcharge L1 fees. Essentially...
(COMMA_BEFORE_BECAUSE)
[grammar] ~25-~25: Consider using either the past participle “overcharged” or the present participle “overcharging” here.
Context: ...emporary liveness risk, because we'd be overcharge L1 fees. Essentially, our L1 cost compu...
(BEEN_PART_AGREEMENT)
[uncategorized] ~73-~73: This looks wrong. Consider replacing it.
Context: ...t release. * op-node
at v1.
* op-geth
at v1.
* op-reth
at [v1.2.0
]...
(AI_EN_LECTOR_REPLACEMENT_SPACE)
[uncategorized] ~107-~107: Possible missing comma found.
Context: ...he Fault Proof System with permissioned games you can skip this section because games...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ 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/notices/pectra-changes.mdx (5)
41-44
: Verify testnet release information.
The newly added testnet release section clearly lists the slot details and timestamps. Please double-check that the dates, slot numbers, and times are accurate and reflect the latest information.
73-74
: Update version references for op-node and op-geth.
The version placeholders forop-node
andop-geth
(displaying asv1.
with empty URLs) remain incomplete. Update these with the correct version numbers and associated hyperlinks to the relevant release notes to ensure users find accurate information.🧰 Tools
114-114
: Confirm absolute prestate generation details.
The updated instruction indicating that the absolute prestate is generated with[op-program/v1.5.0-rc.4]
appears correct. Please verify that the link and hash value provided match the output from your prestate generation process.
128-133
: Verify absolute prestate hash values.
The code block listing the updated hash values for Cannon, Cannon64, and CannonInterop is well formatted. Ensure these hash values are accurate and reflect the output from the latest prestate generation step.
138-139
: Clarify preimage file upload instructions.
The instructions for renaming and uploading the preimage file are clear. Just confirm that the file path (optimism/op-program/bin/prestate.bin.gz
) and the naming convention using the absolute prestate hash meet your deployment and operational requirements.
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/notices/pectra-changes.mdx (4)
22-28
: Clarify fee calculation language and fix typos in the warning callout.
In line 25, the phrase “because we'd be overcharge L1 fees” is grammatically incorrect. Consider changing it to “because fees would be overcharged” (or “because the L1 fees are being overcharged”) to improve clarity. Also, in line 27, correct “instuctions” to “instructions.”Example diff:
- This is not a critical issue on any OP Sepolia chain. However, when L1 blob base fees rise to 100 Mwei or higher on Sepolia, there is a temporary liveness risk, because we'd be overcharge L1 fees. Essentially, our L1 cost computation now overcharges by an exponential of 1.5, BBF\_Cancun = `BBF_Prague^1.5` (where BBF=blob base fee). - You must update your Sepolia nodes to the latest release of op-node to avoid this issue. There are new instuctions in the node operator section to help you mitigate this issue. + This is not a critical issue on any OP Sepolia chain. However, when L1 blob base fees rise to 100 Mwei or higher on Sepolia, there is a temporary liveness risk, because fees would be overcharged exponentially (i.e. BBF_Cancun = `BBF_Prague^1.5`, where BBF denotes the blob base fee). + You must update your Sepolia nodes to the latest release of op-node to avoid this issue. There are new instructions in the node operator section to help mitigate this issue.🧰 Tools
🪛 LanguageTool
[formatting] ~25-~25: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...olia, there is a temporary liveness risk, because we'd be overcharge L1 fees. Essentially...(COMMA_BEFORE_BECAUSE)
[grammar] ~25-~25: Consider using either the past participle “overcharged” or the present participle “overcharging” here.
Context: ...emporary liveness risk, because we'd be overcharge L1 fees. Essentially, our L1 cost compu...(BEEN_PART_AGREEMENT)
77-81
: Refine manual activation instructions for node operators.
The instructional text here could be made clearer. For example, the opening sentence “For node operators of not included in the [hardfork activation inheritance behavior]…” is awkward. Consider rephrasing it as:“For node operators not covered by the hardfork activation inheritance behavior, you will need to manually configure the activation. This can be done in one of two ways:”
This will improve clarity and readability.
107-107
: Fix spelling in the fault proof systems announcement.
In line 107, “permisionless” is misspelled. Update it to “permissionless” to ensure accuracy in technical terminology.Example diff:
-All fault proof enabled chains (both permisionless and permissioned fault proof systems) need to update their `op-challenger` binary to [`op-challenger/v1.3.1`](https://github.com/ethereum-optimism/optimism/releases/tag/op-challenger%2Fv1.3.1). +All fault proof enabled chains (both permissionless and permissioned fault proof systems) need to update their `op-challenger` binary to [`op-challenger/v1.3.1`](https://github.com/ethereum-optimism/optimism/releases/tag/op-challenger%2Fv1.3.1).
152-153
: Review upgrade execution instructions.
The “Execute the upgrade” section instructs operators to simulate and validate the “Set Dispute Game Implementation” transaction before execution. If possible, consider providing additional context or links to recommended simulation tools and best practices.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/notices/pectra-changes.mdx
(5 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with ...
**/*.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. You can fix this by running:Review the changes, then run without :dry to apply them.'pnpm metadata-batch-cli:dry "path/to/this/file.mdx"
- 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/notices/pectra-changes.mdx
🪛 LanguageTool
pages/notices/pectra-changes.mdx
[formatting] ~25-~25: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...olia, there is a temporary liveness risk, because we'd be overcharge L1 fees. Essentially...
(COMMA_BEFORE_BECAUSE)
[grammar] ~25-~25: Consider using either the past participle “overcharged” or the present participle “overcharging” here.
Context: ...emporary liveness risk, because we'd be overcharge L1 fees. Essentially, our L1 cost compu...
(BEEN_PART_AGREEMENT)
[uncategorized] ~73-~73: This looks wrong. Consider replacing it.
Context: ...t release. * op-node
at v1.12.0
* op-geth
at [v1.101503.0
](https://github.com/et...
(AI_EN_LECTOR_REPLACEMENT_SPACE)
[uncategorized] ~109-~109: Possible missing comma found.
Context: ...he Fault Proof System with permissioned games you can skip this section because games...
(AI_HYDRA_LEO_MISSING_COMMA)
⏰ 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/notices/pectra-changes.mdx (5)
41-43
: Verify slot timing details in the upgrade schedule.
The bullet list detailing the slot numbers and times (lines 41–43) is clear. Please verify that the slot numbers, dates, and times are accurate according to the latest upgrade guidelines.
73-74
: Confirm updated version links for op-node and op-geth.
The version updates for op-node (to v1.12.0) and op-geth (to v1.101503.0) look correct. Please double-check that these URLs point to the appropriate releases and consider verifying whether any update is necessary for the op-reth reference.🧰 Tools
🪛 LanguageTool
[uncategorized] ~73-~73: This looks wrong. Consider replacing it.
Context: ...t release. *op-node
atv1.12.0
*op-geth
at [v1.101503.0
](https://github.com/et...(AI_EN_LECTOR_REPLACEMENT_SPACE)
97-97
: Confirm the updated op-batcher version reference.
The bullet point for op-batcher now points to v1.11.5. Please confirm that the version and URL are correct and up to date.
116-116
: Update absolute prestate generation reference.
The reference to [op-program/v1.5.0-rc.4] and the provided absolute prestate hash appear accurate. Please verify that the URL and hash remain valid under the current documentation standards.
140-141
: Clarify instructions for renaming the preimage file.
The instructions to rename the preimage file with the absolute prestate hash are clear and detailed. Ensure that the file path and naming conventions are consistent with the rest of the documentation.
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/notices/pectra-changes.mdx (4)
22-28
: Warning callout: Fix grammar and typos.
• In line 25, the phrase “because we'd be overcharge L1 fees” should be corrected to “because we'd be overcharging L1 fees” (or “overcharged” if that is more appropriate).
• In line 27, “instuctions” should be corrected to “instructions”.🧰 Tools
🪛 LanguageTool
[formatting] ~25-~25: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...olia, there is a temporary liveness risk, because we'd be overcharge L1 fees. Essentially...(COMMA_BEFORE_BECAUSE)
[grammar] ~25-~25: Consider using either the past participle “overcharged” or the present participle “overcharging” here.
Context: ...emporary liveness risk, because we'd be overcharge L1 fees. Essentially, our L1 cost compu...(BEEN_PART_AGREEMENT)
77-83
: Clarify node operator instructions.
In line 77, the phrase “For node operators of not included in the …” is awkward. Consider revising it to “For node operators not included in the …” for clarity.
107-107
: Typo in fault proof chains section.
The word “permisionless” is misspelled. It should be “permissionless”.
109-109
: Improve readability with proper punctuation.
Add a comma after “permissioned games” in line 109 to improve the sentence flow, e.g., “...with permissioned games, you can skip this section…”🧰 Tools
🪛 LanguageTool
[uncategorized] ~109-~109: Possible missing comma found.
Context: ...he Fault Proof System with permissioned games you can skip this section because games...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/notices/pectra-changes.mdx
(5 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with ...
**/*.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. You can fix this by running:Review the changes, then run without :dry to apply them.'pnpm metadata-batch-cli:dry "path/to/this/file.mdx"
- 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/notices/pectra-changes.mdx
🪛 LanguageTool
pages/notices/pectra-changes.mdx
[formatting] ~25-~25: If the ‘because’ clause is essential to the meaning, do not use a comma before the clause.
Context: ...olia, there is a temporary liveness risk, because we'd be overcharge L1 fees. Essentially...
(COMMA_BEFORE_BECAUSE)
[grammar] ~25-~25: Consider using either the past participle “overcharged” or the present participle “overcharging” here.
Context: ...emporary liveness risk, because we'd be overcharge L1 fees. Essentially, our L1 cost compu...
(BEEN_PART_AGREEMENT)
[uncategorized] ~73-~73: This looks wrong. Consider replacing it.
Context: ...t release. * op-node
at v1.12.0
* op-geth
at [v1.101503.0
](https://github.com/et...
(AI_EN_LECTOR_REPLACEMENT_SPACE)
[uncategorized] ~109-~109: Possible missing comma found.
Context: ...he Fault Proof System with permissioned games you can skip this section because games...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~121-~121: The verb ‘prestate’ is plural. Did you mean: “prestates”? Did you use a verb instead of a noun?
Context: ...Soneium You can verify this absolute prestate by running the following [command](http...
(PLURAL_VERB_AFTER_THIS)
⏰ 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/notices/pectra-changes.mdx (3)
1-16
: Frontmatter metadata is complete and correct.
The metadata block contains all required fields with non-empty values.
73-75
: Version reference updates confirmed.
The version references forop-node
,op-geth
, andop-reth
are now properly updated and linked, addressing previous placeholder issues.🧰 Tools
🪛 LanguageTool
[uncategorized] ~73-~73: This looks wrong. Consider replacing it.
Context: ...t release. *op-node
atv1.12.0
*op-geth
at [v1.101503.0
](https://github.com/et...(AI_EN_LECTOR_REPLACEMENT_SPACE)
121-121
: Terminology consistency check.
Verify that “absolute prestate” is the correct and consistent term as per the project’s glossary.🧰 Tools
🪛 LanguageTool
[grammar] ~121-~121: The verb ‘prestate’ is plural. Did you mean: “prestates”? Did you use a verb instead of a noun?
Context: ...Soneium You can verify this absolute prestate by running the following [command](http...(PLURAL_VERB_AFTER_THIS)
updating notice page for the pectra blob fee fix in the op-node and the new absolute prestate