docs: Update superchain_level for Standard chain status to 2 #1287
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request modifies the Superchain blockspace charter documentation, specifically updating the Possibly related PRs
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: 0
🧹 Nitpick comments (1)
pages/superchain/blockspace-charter.mdx (1)
Line range hint
1-111: Align document with style guidelines.Please consider the following improvements to maintain consistency with our documentation guidelines:
Replace personal pronouns with proper nouns:
- Replace "our highest-security blockspace" with "the highest-security blockspace"
- Replace "our highest-security flagship blockspace" with "the highest-security flagship blockspace"
Update headers to use sentence case:
- "The Blockspace and Standard Rollup charters" (currently uses title case)
- "Summary of charters" (correct, already uses sentence case)
- "Understanding chain compliance" (correct, already uses sentence case)
Ensure consistent capitalization of proper nouns throughout the document:
- "Superchain Registry"
- "Standard Rollup Charter"
- "Blockspace Charters"
- "Optimism Foundation"
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/superchain/blockspace-charter.mdx(2 hunks)
🧰 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.
"
⏰ 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/superchain/blockspace-charter.mdx (2)
21-21: LGTM: Superchain level update is accurate.The update to
superchain_level = 2aligns with the recent change in the Superchain Registry.
110-110: LGTM: Consistent update of superchain level.The update to
superchain_levelvalue of2is consistent with the earlier definition and maintains document coherence.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
pages/superchain/superchain-registry.mdx (1)
15-15: LGTM! Consider minor readability improvements.The technical update from
superchain_level = 1tosuperchain_level = 2is correctly documented. The sentence structure and capitalization of proper nouns are appropriate.Consider adding a brief explanation of what
superchain_levelrepresents for better clarity:-* A Superchain Registry repository that shows who's in the registry and the chain's configuration. Chains with `superchain_level = 2` have proven that they follow the Standard Rollup Charter, and can be classified as a Standard Rollup. +* A Superchain Registry repository that shows who's in the registry and the chain's configuration. Chains with `superchain_level = 2` (indicating full compliance) have proven that they follow the Standard Rollup Charter, and can be classified as a Standard Rollup.pages/superchain/blockspace-charter.mdx (2)
21-21: LGTM! Consider enhancing clarity.The technical update from
superchain_level = 1tosuperchain_level = 2is correctly documented. The sentence structure and capitalization of proper nouns are appropriate.Consider adding a brief note about the significance of level 2:
-* **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 = 2` 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 = 2` (the highest compliance tier) meet all the criteria to be classified as a Standard Rollup.
110-110: LGTM! Consider clarifying the promotion process.The technical update from
superchain_level = 1tosuperchain_level = 2is correctly documented. The use of quotes around "Standard" and the explanation of the promotion process are appropriate.Consider adding context about the validation process:
-* **Indicates adherence to the Standard Rollup Charter:** Once the registry validates that a chain meets the standard criteria, it promotes it to "Standard" by setting its `superchain_level` value to `2`. +* **Indicates adherence to the Standard Rollup Charter:** Once the registry validates that a chain meets all standard criteria through automated checks, it promotes it to "Standard" by setting its `superchain_level` value to `2`.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
pages/superchain/blockspace-charter.mdx(2 hunks)pages/superchain/superchain-registry.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
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/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.
"
⏰ 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
There was a problem hiding this comment.
good catch hashigo, thank you
reference: https://github.com/ethereum-optimism/superchain-registry/blob/main/docs/glossary.md
Description
This PR updates the documentation to align with the new superchain_level definition.
The change only updates references where level 1 was previously specified as the Standard chain status to now correctly show level 2. This is a minimal change focusing only on the Standard chain definition, without addressing levels 0 and 1.
Tests
Additional context
Metadata