Superchain Registry docs #1125
Superchain Registry docs #1125
Conversation
Adds a top-level category to left nav and new registry page under it
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 Walkthrough📝 WalkthroughWalkthroughThe pull request introduces several modifications to the In 🔗 Possibly related issues
🔗 Possibly related PRs
🏷 Suggested labels
👥 Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (6)
pages/superchain/superchain-registry.mdx (3)
28-30: Replace personal pronoun with proper nounReplace "We recommend" with "The OP Stack documentation recommends" to maintain consistency in communal documentation.
- We recommend using the [OP Contract Manager](/stack/opcm) to deploy L1 contracts that meet the Standard Config. + The OP Stack documentation recommends using the [OP Contract Manager](/stack/opcm) to deploy L1 contracts that meet the Standard Config.
13-16: Add Oxford comma in bullet point listAdd Oxford comma before "and" in the list for consistency with documentation guidelines.
- * A clear definition of what constitutes a Standard Chain and config - * A step-by-step process new chains can follow to join the registry - * Validation checks to ensure chains follow the standard config before joining the Superchain Registry - * A Superchain Registry repository that shows who's in the registry and what changes they have made to the standard config + * A clear definition of what constitutes a Standard Chain and config, + * A step-by-step process new chains can follow to join the registry, + * Validation checks to ensure chains follow the standard config before joining the Superchain Registry, and + * A Superchain Registry repository that shows who's in the registry and what changes they have made to the standard config
20-22: Maintain consistent capitalization of "Standard Config"The term "Standard Config" should be consistently capitalized throughout the document as it's a proper noun.
- The Standard Config is the set of requirements for an OP Stack chain to be considered a Standard Chain within the Superchain. These requirements are currently a draft, pending governance approval. + The Standard Config is the set of requirements for an OP Stack chain to be considered a Standard Chain within the Superchain. These requirements are currently a draft, pending governance approval.pages/superchain/blockspace-charter.mdx (3)
23-23: Fix subject-verb agreement in summary.The word "provides" should be "provide" as it refers to multiple subjects.
-Blockspace Charters provides the vision and principles +Blockspace Charters provide the vision and principles
41-41: Use correct compound word form."key holders" should be written as "keyholders" according to standard technical documentation practices.
-Expected behaviors for roles like sequencers and upgrade key holders. +Expected behaviors for roles like sequencers and upgrade keyholders.🧰 Tools
🪛 LanguageTool
[grammar] ~41-~41: This noun is normally spelled as one word.
Context: ...s for roles like sequencers and upgrade key holders. * Processes for identifying and reso...(HOLDER_COMPOUNDS)
105-105: Remove duplicate word.The word "the" is repeated unnecessarily.
-Ensures chains align with governance-approved standards in the form the The Standard Charter. +Ensures chains align with governance-approved standards in the form of the Standard Charter.🧰 Tools
🪛 LanguageTool
[duplication] ~105-~105: Possible typo: you repeated a word
Context: ...vernance-approved standards in the form the The Standard Charter. * **Indicates promo...(ENGLISH_WORD_REPEAT_RULE)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (10)
pages/builders/chain-operators/hacks/overview.mdx(1 hunks)pages/builders/chain-operators/tutorials/create-l2-rollup.mdx(1 hunks)pages/chain/testing/dev-node.mdx(1 hunks)pages/index.mdx(1 hunks)pages/stack/getting-started.mdx(1 hunks)pages/superchain/_meta.json(1 hunks)pages/superchain/blockspace-charter.mdx(1 hunks)pages/superchain/superchain-registry.mdx(1 hunks)public/_redirects(1 hunks)words.txt(6 hunks)
✅ Files skipped from review due to trivial changes (3)
- pages/stack/getting-started.mdx
- pages/chain/testing/dev-node.mdx
- pages/builders/chain-operators/tutorials/create-l2-rollup.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
- pages/superchain/_meta.json
🧰 Additional context used
📓 Path-based instructions (4)
pages/superchain/superchain-registry.mdx (1)
Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- 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/index.mdx (1)
Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- 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/superchain/blockspace-charter.mdx (1)
Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- 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/builders/chain-operators/hacks/overview.mdx (1)
Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- 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.
"
🪛 LanguageTool
words.txt
[duplication] ~416-~416: Möglicher Tippfehler: ein Wort wird wiederholt
Context: ...WAVM xlarge XORI xtensibility ZKPs ZKVM Zora zora Mitigations
(GERMAN_WORD_REPEAT_RULE)
pages/superchain/blockspace-charter.mdx
[grammar] ~41-~41: This noun is normally spelled as one word.
Context: ...s for roles like sequencers and upgrade key holders. * Processes for identifying and reso...
(HOLDER_COMPOUNDS)
[duplication] ~105-~105: Possible typo: you repeated a word
Context: ...vernance-approved standards in the form the The Standard Charter. * **Indicates promo...
(ENGLISH_WORD_REPEAT_RULE)
🔇 Additional comments (5)
pages/builders/chain-operators/hacks/overview.mdx (1)
13-13: LGTM! Link path update is correct
The hyperlink update to the new Superchain documentation path is accurate and consistent with the documentation restructuring.
pages/index.mdx (1)
60-60: LGTM! Card href update is consistent
The Card component's href update aligns with the new documentation structure and maintains consistency with other similar changes across the documentation.
pages/superchain/blockspace-charter.mdx (3)
1-5: LGTM! Frontmatter is well-structured.
The title and description are clear, concise, and properly formatted.
7-14: LGTM! Introduction follows documentation guidelines.
The section maintains proper capitalization of technical terms and uses appropriate language without personal pronouns.
56-100: LGTM! Standard Rollup Charter section is well-documented.
The section maintains consistent formatting and proper linking to external resources.
|
This PR fixes: https://github.com/ethereum-optimism/devrel/issues/369 |
|
fixes: #1187 |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
pages/superchain/blockspace-charter.mdx (5)
2-2: Ensure consistency between frontmatter title and H1 headerThe frontmatter title and H1 header should be identical. Currently:
- Frontmatter: "Blockspace and Standard Rollup Charters"
- H1: "The Blockspace and Standard Rollup charters"
-# The Blockspace and Standard Rollup charters +# Blockspace and Standard Rollup ChartersAlso applies to: 7-7
13-13: Add missing comma for better readabilityAdd a comma after "charters" to properly separate the clauses.
-This doc mostly covers the charters but references the Superchain Registry as they are all deeply connected. +This doc mostly covers the charters, but references the Superchain Registry as they are all deeply connected.🧰 Tools
🪛 LanguageTool
[uncategorized] ~13-~13: Possible missing comma found.
Context: ...charters, but references the Superchain Registry as they are all deeply connected. Read ...(AI_HYDRA_LEO_MISSING_COMMA)
21-21: Fix grammatical error in Superchain Registry descriptionThe sentence has a grammatical error with "with set as".
-* **Superchain Registry:** The Superchain Registry is an index of chains which serves as the source of truth for who's in the Superchain ecosystem and the chain's configuration. The registry checks for compliance with the Standard Rollup Charter. Chains with set as `superchain_level = 1` meet all the criteria to be classified as a Standard Rollup. +* **Superchain Registry:** The Superchain Registry is an index of chains which serves as the source of truth for who's in the Superchain ecosystem and the chain's configuration. The registry checks for compliance with the Standard Rollup Charter. Chains with `superchain_level = 1` meet all the criteria to be classified as a Standard Rollup.🧰 Tools
🪛 LanguageTool
[uncategorized] ~21-~21: Possible missing article found.
Context: ...he Standard Rollup Charter. Chains with set assuperchain_level = 1meet all the ...(AI_HYDRA_LEO_MISSING_A)
43-43: Fix grammatical and style issuesSeveral issues need to be addressed:
- "key holders" should be "keyholders"
- "blockspace charters ensures" should be "blockspace charters ensure"
- "outside of" is redundant
-* Expected behaviors for roles like sequencers and upgrade key holders. +* Expected behaviors for roles like sequencers and upgrade keyholders. -By defining these components, blockspace charters ensures secure, scalable, and governed blockspace while fostering trust and alignment within the ecosystem. +By defining these components, blockspace charters ensure secure, scalable, and governed blockspace while fostering trust and alignment within the ecosystem. -* **Foundation discretion**: Changes to validation, outside of the three TOML files referenced above, remain at the Foundation's discretion. +* **Foundation discretion**: Changes to validation outside the three TOML files referenced above remain at the Foundation's discretion.Also applies to: 54-54, 61-61
🧰 Tools
🪛 LanguageTool
[grammar] ~43-~43: This noun is normally spelled as one word.
Context: ...s for roles like sequencers and upgrade key holders. * Processes for identifying and reso...(HOLDER_COMPOUNDS)
110-110: Fix word repetitionRemove the repeated word "the".
-* **Validates version and configuration:** The registry validates that chains align with governance-approved standards in the form the The Standard Rollup Charter. +* **Validates version and configuration:** The registry validates that chains align with governance-approved standards in the form of the Standard Rollup Charter.🧰 Tools
🪛 LanguageTool
[duplication] ~110-~110: Possible typo: you repeated a word
Context: ...vernance-approved standards in the form the The Standard Rollup Charter. * **Indicate...(ENGLISH_WORD_REPEAT_RULE)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
pages/superchain/blockspace-charter.mdx(1 hunks)pages/superchain/superchain-registry.mdx(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- pages/superchain/superchain-registry.mdx
🧰 Additional context used
📓 Path-based instructions (1)
pages/superchain/blockspace-charter.mdx (1)
Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- 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.
"
🪛 LanguageTool
pages/superchain/blockspace-charter.mdx
[uncategorized] ~13-~13: Possible missing comma found.
Context: ...charters, but references the Superchain Registry as they are all deeply connected. Read ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~21-~21: Possible missing article found.
Context: ...he Standard Rollup Charter. Chains with set as superchain_level = 1 meet all the ...
(AI_HYDRA_LEO_MISSING_A)
[grammar] ~43-~43: This noun is normally spelled as one word.
Context: ...s for roles like sequencers and upgrade key holders. * Processes for identifying and reso...
(HOLDER_COMPOUNDS)
[style] ~61-~61: This phrase is redundant. Consider using “outside”.
Context: ...on discretion**: Changes to validation, outside of the three TOML files referenced above, ...
(OUTSIDE_OF)
[duplication] ~110-~110: Possible typo: you repeated a word
Context: ...vernance-approved standards in the form the The Standard Rollup Charter. * **Indicate...
(ENGLISH_WORD_REPEAT_RULE)
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (1)
pages/superchain/blockspace-charter.mdx (1)
43-43: Improve clarity and consistencyMinor style improvements needed:
Apply this diff:
-* Expected behaviors for roles like sequencers and upgrade key holders. +* Expected behaviors for roles like sequencers and upgrade keyholders. -* **Foundation discretion**: Changes to validation, outside of the three TOML files referenced above, +* **Foundation discretion**: Changes to validation outside the three TOML files referenced above,Also applies to: 61-61
🧰 Tools
🪛 LanguageTool
[grammar] ~43-~43: This noun is normally spelled as one word.
Context: ...s for roles like sequencers and upgrade key holders. * Processes for identifying and reso...(HOLDER_COMPOUNDS)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
pages/superchain/blockspace-charter.mdx(1 hunks)pages/superchain/superchain-registry.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
pages/superchain/blockspace-charter.mdx (1)
Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- 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/superchain/superchain-registry.mdx (1)
Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- 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.
"
🪛 LanguageTool
pages/superchain/blockspace-charter.mdx
[uncategorized] ~21-~21: Possible missing article found.
Context: ...he Standard Rollup Charter. Chains with set as superchain_level = 1 meet all the ...
(AI_HYDRA_LEO_MISSING_A)
[grammar] ~43-~43: This noun is normally spelled as one word.
Context: ...s for roles like sequencers and upgrade key holders. * Processes for identifying and reso...
(HOLDER_COMPOUNDS)
[style] ~61-~61: This phrase is redundant. Consider using “outside”.
Context: ...on discretion**: Changes to validation, outside of the three TOML files referenced above, ...
(OUTSIDE_OF)
[duplication] ~109-~109: Possible typo: you repeated a word
Context: ...vernance-approved standards in the form the The Standard Rollup Charter. * **Indicate...
(ENGLISH_WORD_REPEAT_RULE)
pages/superchain/superchain-registry.mdx
[uncategorized] ~15-~15: Possible missing article found.
Context: ... the chain's configuration. Chains with set as superchain_level = 1 meet all the ...
(AI_HYDRA_LEO_MISSING_A)
🔇 Additional comments (4)
pages/superchain/superchain-registry.mdx (2)
1-8: LGTM!
The metadata and imports are properly structured.
17-27: LGTM!
The Standard Rollup section accurately describes the requirements and includes helpful deployment recommendations.
pages/superchain/blockspace-charter.mdx (2)
1-14: LGTM!
The metadata and introduction provide clear context and are properly structured.
65-104: LGTM!
The Standard Rollup Charter section is comprehensive and provides clear guidance.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: Tess Rinearson <[email protected]>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (7)
pages/superchain/blockspace-charter.mdx (7)
1-5: Maintain consistent capitalization in title and descriptionFor consistency with the coding guidelines, maintain proper capitalization of technical terms throughout the frontmatter.
Apply this diff:
-title: Blockspace and Standard Rollup Charters +title: Blockspace and Standard Rollup Charter -description: Learn about Blockspace Charters, the Standard Rollup Charter, and the Superchain Registry. +description: Learn about Blockspace Charter, the Standard Rollup Charter, and the Superchain Registry.
7-7: Use sentence case for H1 headerAccording to the coding guidelines, H1 headers should use sentence case while preserving the capitalization of proper nouns.
Apply this diff:
-# The Blockspace and Standard Rollup charters +# The Blockspace and Standard Rollup Charter
9-9: Improve sentence structure by removing redundancyThe sentence contains redundant wording with "provide" and "foundation".
Apply this diff:
-Blockspace Charters provide the essential technical and governance framework for the Superchain ecosystem. These frameworks provide a secure and scalable foundation for all stakeholders. +Blockspace Charter provides the essential technical and governance framework for the Superchain ecosystem, establishing a secure and scalable foundation for all stakeholders.
54-54: Fix subject-verb agreementThe subject "charters" (plural) doesn't agree with the verb "ensures" (singular).
Apply this diff:
-By defining these components, blockspace charters ensures secure, scalable, and governed blockspace while fostering trust and alignment within the ecosystem. +By defining these components, blockspace charters ensure secure, scalable, and governed blockspace while fostering trust and alignment within the ecosystem.
61-61: Improve conciseness by removing redundant phraseThe phrase "outside of" is redundant. Use "outside" instead.
Apply this diff:
-* **Foundation discretion**: Changes to validation, outside of the three TOML files referenced above, remain at the Foundation's discretion. +* **Foundation discretion**: Changes to validation outside the three TOML files referenced above remain at the Foundation's discretion.🧰 Tools
🪛 LanguageTool
[style] ~61-~61: This phrase is redundant. Consider using “outside”.
Context: ...on discretion**: Changes to validation, outside of the three TOML files referenced above, ...(OUTSIDE_OF)
69-69: Update link to use main branch instead of feature branchThe link points to a feature branch which may be temporary. It's better to reference the main branch for stability.
Apply this diff:
-Learn more about The Standard Charter in [the governance post](https://github.com/ethereum-optimism/OPerating-manual/blob/feat/standard-rollup-charter/Standard%20Rollup%20Charter.md#standard-rollup-charter). +Learn more about The Standard Charter in [the governance post](https://github.com/ethereum-optimism/OPerating-manual/blob/main/Standard%20Rollup%20Charter.md#standard-rollup-charter).
90-90: Add missing period for consistencyAdd a period at the end of the sentence to maintain consistent punctuation throughout the document.
Apply this diff:
-Read more about Off-Chain checks in the [repo](https://github.com/ethereum-optimism/OPerating-manual/blob/feat/standard-rollup-charter/Standard%20Rollup%20Charter.md#offchain-criteria) +Read more about Off-Chain checks in the [repo](https://github.com/ethereum-optimism/OPerating-manual/blob/feat/standard-rollup-charter/Standard%20Rollup%20Charter.md#offchain-criteria).
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
pages/superchain/_meta.json(1 hunks)pages/superchain/blockspace-charter.mdx(1 hunks)pages/superchain/superchain-registry.mdx(1 hunks)public/_redirects(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
- pages/superchain/_meta.json
- pages/superchain/superchain-registry.mdx
🧰 Additional context used
📓 Path-based instructions (1)
pages/superchain/blockspace-charter.mdx (1)
Pattern **/*.mdx: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- 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.
"
🪛 LanguageTool
pages/superchain/blockspace-charter.mdx
[grammar] ~43-~43: This noun is normally spelled as one word.
Context: ...s for roles like sequencers and upgrade key holders. * Processes for identifying and reso...
(HOLDER_COMPOUNDS)
[style] ~61-~61: This phrase is redundant. Consider using “outside”.
Context: ...on discretion**: Changes to validation, outside of the three TOML files referenced above, ...
(OUTSIDE_OF)
🔇 Additional comments (2)
public/_redirects (2)
119-119: Remove duplicate redirect.
The redirect /builders/chain-operators/tutorials/sdk to /builders/app-developers/overview appears twice in the file. Remove this duplicate entry to maintain a clean configuration.
120-120: LGTM: Superchain documentation redirect.
The redirect from /stack/explainer to /superchain/superchain-explainer aligns well with the PR's objective of improving Superchain documentation organization.
The SuperchainSuperchain RegistryexplainerBlockspace and Standard Rollup charterexplainer