Added banner and notice page for SDK deprecation #928
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
krofax
changed the title
WalkthroughThis pull request introduces changes related to the deprecation of the Optimism SDK. It adds a new documentation page that details the migration to the Changes
Possibly related PRs
Suggested labels
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
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 7
🧹 Outside diff range and nitpick comments (2)
pages/builders/notices/_meta.json (1)
3-4: LGTM! The changes align with the PR objectives.The addition of the "sdk-deprecation" entry is appropriate and consistent with the existing structure. It clearly indicates the purpose of preparing users for the Optimism SDK deprecation, which aligns with the PR objectives.
For consistency with the other entries, consider capitalizing "SDK" in the value:
- "sdk-deprecation": "Preparing for Optimism SDK deprecation" + "sdk-deprecation": "Preparing for Optimism SDK Deprecation"pages/builders/notices/sdk-deprecation.mdx (1)
61-64: Clarify package manager usage in the code snippet.The code snippet uses both
pnpmandnpmcommands, which might be confusing for users. Consider using a single package manager or providing instructions for both.Consider revising the code snippet as follows:
```bash # If using npm npm uninstall @eth-optimism/sdk npm install viem # If using pnpm pnpm remove @eth-optimism/sdk pnpm add viem</blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: .coderabbit.yaml** **Review profile: CHILL** <details> <summary>📥 Commits</summary> Files that changed from the base of the PR and between d7efe1c4761cf221eadc1409855797d4c61620dd and 138050284dcf0c56a8fc8bdf582b901b4bd387bd. </details> <details> <summary>📒 Files selected for processing (4)</summary> * pages/builders/notices/_meta.json (1 hunks) * pages/builders/notices/sdk-deprecation.mdx (1 hunks) * theme.config.tsx (1 hunks) * words.txt (1 hunks) </details> <details> <summary>✅ Files skipped from review due to trivial changes (1)</summary> * words.txt </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>📓 Path-based instructions (1)</summary><blockquote> <details> <summary>pages/builders/notices/sdk-deprecation.mdx (1)</summary> 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. Use **bold** for prominence instead of all caps or italics. - Ensure proper nouns are capitalized in sentences. - Apply the Oxford comma. - Use proper title case for headers, 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). " </details> </blockquote></details> <details> <summary>🪛 LanguageTool</summary><blockquote> <details> <summary>pages/builders/notices/sdk-deprecation.mdx</summary><blockquote> [uncategorized] ~23-~23: You might be missing the article “the” here. Context: ... our tutorials and documentation to use `viem/opstack` library. Below, you'll fin... (AI_EN_LECTOR_MISSING_DETERMINER_THE) --- [uncategorized] ~73-~73: This verb does not appear to agree with the subject. Consider using a different form. Context: ...em/opstack`. The `viem/opstack` library offer more efficient methods to handle these ... (AI_EN_LECTOR_REPLACEMENT_VERB_AGREEMENT) </blockquote></details> </blockquote></details> <details> <summary>🪛 GitHub Check: lint</summary><blockquote> <details> <summary>pages/builders/notices/sdk-deprecation.mdx</summary><blockquote> [warning] 1-1: Must have required property 'lang' • /home/runner/work/docs/docs/utils/schemas/page.schema.yaml • #/required </blockquote></details> </blockquote></details> </details> <details> <summary>🔇 Additional comments (4)</summary><blockquote> <details> <summary>pages/builders/notices/sdk-deprecation.mdx (2)</summary><blockquote> `21-50`: **LGTM: Updated Tutorials section is well-structured and informative.** The "Updated Tutorials" section provides a comprehensive list of updated and deprecated tutorials with clear descriptions. The use of relative links is good for maintainability. <details> <summary>🧰 Tools</summary> <details> <summary>🪛 LanguageTool</summary><blockquote> [uncategorized] ~23-~23: You might be missing the article “the” here. Context: ... our tutorials and documentation to use `viem/opstack` library. Below, you'll fin... (AI_EN_LECTOR_MISSING_DETERMINER_THE) </blockquote></details> </details> --- `81-90`: **LGTM: For Node Operators section is well-structured and informative.** The "For Node Operators" section provides clear guidance for node operators on migrating to `viem/opstack`. The use of bullet points is consistent with other sections, making the information easy to read and follow. </blockquote></details> <details> <summary>theme.config.tsx (2)</summary><blockquote> `31-38`: **LGTM! Banner implementation looks good.** The added banner property effectively communicates the SDK deprecation notice to users. It aligns well with the PR objectives by providing a visible link to the deprecation notice page. A few observations: 1. The use of an emoji (🎉) adds a friendly touch to the notification. 2. The link opens in a new tab (`target="_blank"`), which is good for user experience. 3. The key 'viem/op-stack' suggests this banner is specific to the migration to viem/op-stack, allowing for potential future banners if needed. --- Line range hint `1-184`: **Summary: Banner addition is well-implemented and non-disruptive.** The changes in this file are minimal and focused, which is excellent for maintainability. The addition of the banner property to the configuration object effectively addresses the PR objective of notifying users about the SDK deprecation. Key points: 1. The banner implementation is clean and doesn't interfere with existing configuration. 2. The change aligns well with the PR objectives. 3. The rest of the file remains unchanged, minimizing the risk of unintended side effects. Overall, this is a well-executed change that enhances user communication without disrupting the existing documentation structure. </blockquote></details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
There was a problem hiding this comment.
Actionable comments posted: 8
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
- pages/builders/notices/sdk-deprecation.mdx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
pages/builders/notices/sdk-deprecation.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. Use bold for prominence instead of all caps or italics.
- Ensure proper nouns are capitalized in sentences.
- Apply the Oxford comma.
- Use proper title case for headers, 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).
"
🪛 GitHub Check: lint
pages/builders/notices/sdk-deprecation.mdx
[warning] 1-1:
Must have required property 'lang' • /home/runner/work/docs/docs/utils/schemas/page.schema.yaml • #/required
🔇 Additional comments (4)
pages/builders/notices/sdk-deprecation.mdx (4)
54-71: LGTM: App Developers section is informative and well-structuredThe "For App Developers" section provides clear and helpful guidance for migrating from the Optimism SDK to the
viem/opstacklibrary. The content is well-organized and includes a useful code snippet for installing dependencies.
83-92: LGTM: Node Operators section is clear and informativeThe "For Node Operators" section provides concise and helpful guidance for node operators transitioning from the Optimism SDK to the
viem/opstacklibrary. The content is well-structured and covers key points such as updating node software, reviewing configurations, and thorough testing.
1-100: LGTM: Comprehensive and well-structured document on SDK deprecationThe document provides a thorough overview of the Optimism SDK deprecation and the transition to the
viem/opstacklibrary. It effectively covers:
- Introduction and timeline
- Breaking changes to expect
- Updated tutorials
- Guidance for app developers, chain operators, and node operators
- Resources for further assistance
The structure is logical, and the content is informative. While there are some minor issues with language and formatting (addressed in previous comments), the overall document serves its purpose well.
🧰 Tools
🪛 GitHub Check: lint
[warning] 1-1:
Must have required property 'lang' • /home/runner/work/docs/docs/utils/schemas/page.schema.yaml • #/required
1-100: Summary: Solid documentation with minor improvements neededThis document on the Optimism SDK deprecation is comprehensive and well-structured. It effectively communicates the necessary information to various stakeholders. Here's a summary of the key points and suggested improvements:
- Add the 'lang' property to the frontmatter for compliance with the page schema.
- Revise language throughout to use proper nouns instead of personal pronouns for consistency in communal documentation.
- Correct typos and grammatical errors, particularly in the "Updated Tutorials" and "Need Help?" sections.
- Improve formatting in the "Need Help?" section for better readability.
- Uncomment and review the tutorial links to ensure they are up-to-date and functional.
Overall, the document is informative and valuable. Implementing these suggestions will enhance its clarity and effectiveness.
🧰 Tools
🪛 GitHub Check: lint
[warning] 1-1:
Must have required property 'lang' • /home/runner/work/docs/docs/utils/schemas/page.schema.yaml • #/required
|
@bradleycamacho mind giving this a review? |
Description
A notice page informing community of the SDK deprecation and a migration to viem/opstack library
Tests
Please describe any tests you've added. If you've added no tests, or left important behavior untested, please explain why not.
Additional context
Add any other context about the problem you're solving.
Metadata