add docs on alpha- and betanets #1264
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request introduces a new markdown file Possibly related PRs
Suggested reviewers
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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
|
Co-authored-by: Blessing Krofegha <[email protected]>
![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 (7)
pages/stack/public-devnets.mdx (7)
7-7: Remove unused import.The
Calloutcomponent is imported but never used in the document.-import { Callout } from 'nextra/components'
10-10: Avoid using italics for emphasis.According to the guidelines, avoid using italics for emphasis.
-There are two different kinds of public devnets: *alphanets* and *betanets*, which serve different purposes and are deployed on different timelines. +There are two different kinds of public devnets: alphanets and betanets, which serve different purposes and are deployed on different timelines.
15-15: Replace personal pronouns with proper nouns.Replace "We" with "OP Labs" to maintain consistency in communal documentation.
-We rely on alphanets to move faster while improving the reliability of upgrades. +OP Labs relies on alphanets to move faster while improving the reliability of upgrades.
18-18: Avoid using italics for emphasis.According to the guidelines, avoid using italics for emphasis.
-Features _must_ be included on an alphanet before they can be deployed on a betanet. +Features must be included on an alphanet before they can be deployed on a betanet.
20-22: Replace personal pronouns and contractions.Replace personal pronouns with proper nouns and expand contractions for clarity in technical documentation.
-Alphanets decouple feature development and testing from hardfork scheduling, allowing us to test and iterate on features well in advance of their release on mainnet. +Alphanets decouple feature development and testing from hardfork scheduling, allowing OP Labs to test and iterate on features well in advance of their release on mainnet. -They're designed to stay fresh: Each one is deployed monthly and replaced, so they won't be useable as long-term networks. +These networks are designed to stay fresh: Each one is deployed monthly and replaced, so they will not be useable as long-term networks.
35-36: Replace personal pronouns and avoid italics.Replace personal pronouns with proper nouns and avoid using italics for emphasis.
-A betanet includes the exact set of features that we expect to include in the next network upgrade. -Features _must_ be included on a betanet before they can be deployed on a testnet. +A betanet includes the exact set of features planned for inclusion in the next network upgrade. +Features must be included on a betanet before they can be deployed on a testnet.
54-55: Use proper markdown link formatting.Convert raw URLs to proper markdown links for better readability.
-* RPC endpoint: https://alpaca-0.optimism.io -* `manifest.yaml`: https://github.com/ethereum-optimism/devnets/blob/main/alphanets/alpaca/manifest.yaml +* RPC endpoint: [https://alpaca-0.optimism.io](https://alpaca-0.optimism.io) +* `manifest.yaml`: [View on GitHub](https://github.com/ethereum-optimism/devnets/blob/main/alphanets/alpaca/manifest.yaml)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/stack/public-devnets.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
pages/stack/public-devnets.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 (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/stack/public-devnets.mdx (1)
40-45: LGTM!The comparison table is well-structured and provides clear, valuable information about the differences between alphanets and betanets.
There was a problem hiding this comment.
Actionable comments posted: 6
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
pages/stack/public-devnets.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
pages/stack/public-devnets.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.
"
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
No description provided.