Update sdk-deprecation.mdx #1025
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Warning Rate limit exceeded@sbvegan has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 14 minutes and 25 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughThe document "Deprecation of the Optimism SDK" has been revised to announce the transition to the Changes
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: 1
🧹 Outside diff range and nitpick comments (3)
pages/builders/notices/sdk-deprecation.mdx (3)
Line range hint
8-9: Use specific project name instead of generic referenceReplace "The project" with "Optimism" to maintain clarity and proper noun usage in communal documentation.
-The project is shifting to the `viem` library +Optimism is shifting to the `viem` library
Line range hint
28-28: Use imperative form instead of personal pronounsReplace "We are updating" with an imperative form to maintain consistency in communal documentation.
-We are updating our tutorials to use the `viem` library. +All tutorials are being updated to use the `viem` library.
Line range hint
39-42: Include alternative package managers and fix indentationAdd npm and yarn commands, and fix code block indentation for better readability.
- pnpm remove @eth-optimism/sdk - pnpm add viem +# Using pnpm +pnpm remove @eth-optimism/sdk +pnpm add viem + +# Using npm +npm uninstall @eth-optimism/sdk +npm install viem + +# Using yarn +yarn remove @eth-optimism/sdk +yarn add viem
📜 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. 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 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).
- Use sentence case for H1, H2, and H3 headers, capitalizing only the first word and any proper nouns.
- For all headers (H1, H2, H3), do not change the capitalization of proper nouns; keep them as they are.
"
🔇 Additional comments (1)
pages/builders/notices/sdk-deprecation.mdx (1)
71-71: Developer forum link addition approvedThe addition of the developer forum link aligns with the PR objectives and provides a clear path for developer discussions.
Co-authored-by: Bradley Camacho <[email protected]>
Description
Pointing to our developers repo discussion section