Replace the SDK link with viem #1105
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Warning Rate limit exceeded@krofax has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 17 minutes and 0 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 changes in this pull request primarily involve updating documentation related to bridging ERC-20 tokens and ETH to reflect a transition from the Optimism SDK to the "viem" library. This includes modifications to tutorial links, descriptions, and titles across various markdown files. The updates aim to ensure that developers are directed to the appropriate resources for utilizing viem in their bridging processes, while maintaining the overall structure and content of the documents. Changes
Possibly related issues
Possibly related PRs
Suggested labels
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: 5
🧹 Outside diff range and nitpick comments (5)
pages/builders/app-developers/tutorials/standard-bridge-standard-token.mdx (1)
Line range hint
1-7: Update title to use sentence caseAccording to the documentation guidelines, H1 headers should use sentence case. Update the title to:
"Bridging your standard ERC-20 token using the Standard Bridge"pages/builders/app-developers/overview.mdx (2)
61-61: Fix extra space in tutorial titleRemove the extra space between "with" and "viem".
-| [Tracing Deposits and Withdrawals with viem](tutorials/sdk-trace-txns) | Learn how to use viem to trace deposits and withdrawals. | 🟢 Easy | +| [Tracing Deposits and Withdrawals with viem](tutorials/sdk-trace-txns) | Learn how to use viem to trace deposits and withdrawals. | 🟢 Easy |
63-63: Fix capitalization in titleThe word "address" should be capitalized as it appears in the middle of the title.
-| [Viewing Deposits and Withdrawals by address with viem](tutorials/sdk-view-txns) | Learn how to use viem to view deposits and withdrawals by address. | 🟢 Easy | +| [Viewing Deposits and Withdrawals by Address with viem](tutorials/sdk-view-txns) | Learn how to use viem to view deposits and withdrawals by address. | 🟢 Easy |pages/connect/contribute/style-guide.mdx (2)
323-331: Improve table formatting for better readability.The table structure could be enhanced for better readability and consistency.
Apply this diff to improve the table formatting:
-| Document type | Purpose | Examples | -| ------------------ | ------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------- | +| Document type | Purpose | Examples | +| ---------------- | ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |
408-408: Consider rephrasing the FAQ guidance.The statement about avoiding FAQs could be more constructive by explaining alternative approaches.
Apply this diff to improve the guidance:
-Whenever possible, we should avoid using FAQs due to their lack of readability and difficulty of maintenance. +Consider organizing information in a more structured format instead of FAQs, as they can be difficult to maintain and navigate. When information can be naturally integrated into relevant sections of documentation, this is often more useful for readers than a separate FAQ.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (10)
pages/builders/app-developers/bridging/basics.mdx(1 hunks)pages/builders/app-developers/bridging/standard-bridge.mdx(1 hunks)pages/builders/app-developers/overview.mdx(1 hunks)pages/builders/app-developers/tutorials.mdx(1 hunks)pages/builders/app-developers/tutorials/_meta.json(1 hunks)pages/builders/app-developers/tutorials/standard-bridge-custom-token.mdx(1 hunks)pages/builders/app-developers/tutorials/standard-bridge-standard-token.mdx(1 hunks)pages/builders/chain-operators/tutorials.mdx(2 hunks)pages/builders/tools/overview.mdx(1 hunks)pages/connect/contribute/style-guide.mdx(3 hunks)
✅ Files skipped from review due to trivial changes (2)
- pages/builders/app-developers/bridging/standard-bridge.mdx
- pages/builders/app-developers/tutorials/_meta.json
🧰 Additional context used
📓 Path-based instructions (8)
pages/builders/app-developers/bridging/basics.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/builders/app-developers/overview.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/builders/app-developers/tutorials.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/builders/app-developers/tutorials/standard-bridge-custom-token.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/builders/app-developers/tutorials/standard-bridge-standard-token.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/builders/chain-operators/tutorials.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/builders/tools/overview.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/connect/contribute/style-guide.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.
"
🪛 LanguageTool
pages/builders/chain-operators/tutorials.mdx
[grammar] ~13-~13: The verb ‘precompile’ does not usually follow articles like ‘a’. Check that ‘precompile’ is spelled correctly; using ‘precompile’ as a noun may be non-standard.
Context: ...utes to the derivation function, adding a precompile, creating your own l2 rollup testnet, i...
(A_INFINITIVE)
[uncategorized] ~13-~13: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...s and using viem. You'll find overview, tutorial, guide to help you understand and work ...
(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
🔇 Additional comments (6)
pages/builders/app-developers/bridging/basics.mdx (1)
31-32: LGTM! Documentation updates follow guidelines.
The link text changes correctly reflect the transition from Optimism SDK to viem while maintaining proper sentence case and technical term capitalization.
Let's verify that the linked pages exist and have been updated accordingly:
✅ Verification successful
All linked tutorial pages exist and include "viem" as updated.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify that the referenced tutorial pages exist and contain updated content
# Check if the tutorial files exist and contain "viem" references
rg -l "/builders/app-developers/tutorials/cross-dom-bridge-" | xargs rg -l "viem"
# Verify the content of these specific tutorials
for file in $(fd -t f "cross-dom-bridge-(erc20|eth)\.mdx$"); do
echo "=== $file ==="
rg -A 2 -B 2 "viem" "$file"
done
Length of output: 1851
pages/builders/tools/overview.mdx (1)
53-53: LGTM! Verify the viem documentation link.
The card replacement maintains visual consistency with other cards in the section and aligns with the broader transition from Optimism SDK to viem.
✅ Verification successful
The viem documentation link is accessible. Next, please verify that it contains relevant OP Stack content.
The viem documentation link is accessible and contains relevant OP Stack content.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify the viem documentation link is accessible and contains relevant OP Stack content
curl -sI "https://viem.sh/op-stack/" | head -n 1
Length of output: 60
Script:
#!/bin/bash
# Description: Verify that the viem documentation page includes relevant OP Stack content
curl -s "https://viem.sh/op-stack/" | grep -i "OP Stack"
Length of output: 33222
pages/builders/app-developers/tutorials/standard-bridge-standard-token.mdx (1)
99-99: LGTM: Link update aligns with migration to viem
The update to reference the viem tutorial instead of the SDK is consistent with the PR objectives and maintains proper documentation standards.
pages/builders/app-developers/overview.mdx (2)
54-56: LGTM: Table structure is well-formatted
The table header and alignment are properly formatted with clear column names.
54-64: LGTM: Documentation follows style guidelines
The document maintains consistent formatting, proper capitalization of technical terms, and appropriate use of the Oxford comma throughout the tutorial table.
pages/builders/app-developers/tutorials/standard-bridge-custom-token.mdx (1)
117-117: 🛠️ Refactor suggestion
Improve capitalization in the tutorial link text
The technical terms "ERC-20" and "viem" should maintain their proper capitalization:
-Check out the tutorial on [Bridging ERC-20 tokens with viem](./cross-dom-bridge-erc20) to learn how to bridge your L1 ERC-20 to L2s using viem.
+Check out the tutorial on [Bridging ERC-20 Tokens with Viem](./cross-dom-bridge-erc20) to learn how to bridge your L1 ERC-20 to L2s using Viem.✅ Verification successful
Capitalization Correct in Tutorial Link Text
The technical terms "ERC-20" and "Viem" are properly capitalized, and the referenced tutorial exists.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify that the referenced tutorial exists
# Expected: The cross-dom-bridge-erc20.mdx file should exist in the same directory
# Check if the referenced tutorial file exists
fd -e mdx "cross-dom-bridge-erc20" pages/builders/app-developers/tutorials/
Length of output: 142
Description
Replaced the Optimism SDK link with the viem link.
Tests
Additional context
Metadata
Include a link to any github issues that this may close in the following form: