devnets: reduce duplicate info and point to the devnets website instead #1283
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 Possibly related PRs
Suggested labels
Suggested reviewers
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (4)
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 (3)
pages/stack/public-devnets.mdx (3)
49-49: Consider renaming the section header for clarity.The section header "Current devnets" might be misleading since it no longer contains the actual devnet information. Consider using a more appropriate header like "Active devnets" or "Finding current devnets" to better reflect the content.
-## Current devnets +## Finding current devnets
51-51: Enhance link text for better accessibility.Consider using more descriptive link text instead of just the URL. This improves accessibility and provides better context for users.
-A full list of active alpha- and betanets is available at <https://devnets.optimism.io/>. +A full list of active alpha- and betanets is available on the [OP Stack Devnets website](https://devnets.optimism.io/).
Line range hint
11-11: Replace personal pronoun with proper noun.According to the documentation guidelines, replace "We" with the proper noun "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.
📜 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 (1)
- GitHub Check: pr-workflow
sbvegan
dismissed
their stale review
Chatted with slipper on slack about this
We now have https://devnets.optimism.io/, and we should point to this in the docs rather than manually duplicating info about each devnet.