viem updates #1064
Merged
viem updates #1064
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
cpengilly
commented
Nov 1, 2024
cpengilly
commented
- fix meta json file
- add Viem as proper noun
- update tutorial page to reflect
- fix meta json file - add Viem as proper noun - update tutorial page to reflect
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
WalkthroughThe pull request introduces changes to three files. The Changes
Possibly related issues
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: 0
🧹 Outside diff range and nitpick comments (3)
pages/builders/app-developers/tutorials/cross-dom-bridge-eth.mdx (3)
Line range hint
11-13: Revise to use more formal languageReplace personal pronouns with more formal language to maintain consistency in communal documentation:
-This tutorial explains how you can use [Viem](https://viem.sh) to bridge ETH from L1 (Ethereum or Sepolia) to L2 (OP Mainnet or OP Sepolia). +This tutorial explains how to use [Viem](https://viem.sh) to bridge ETH from L1 (Ethereum or Sepolia) to L2 (OP Mainnet or OP Sepolia). -It offers an easy way to add bridging functionality to your JavaScript-based application. +It offers an easy way to add bridging functionality to JavaScript-based applications.
Line range hint
138-140: Remove personal pronoun from calloutReplace "We" with a more formal construction:
- We used `formatEther` method from `viem` to format the balance to ether. + The `formatEther` method from `viem` formats the balance to ether.
Line range hint
95-112: Consider revising remaining personal pronounsSeveral sections still use personal pronouns ("you", "your"). Consider revising these to maintain a more formal tone throughout the document. For example:
-You're going to need some ETH on L1 that you can bridge to L2. +ETH on L1 is required for bridging to L2. -You just bridged some ETH from L1 to L2. +After bridging ETH from L1 to L2, the next step is to repeat the process in reverse.Also applies to: 201-206
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (3)
nouns.txt(1 hunks)pages/builders/app-developers/tutorials/_meta.json(1 hunks)pages/builders/app-developers/tutorials/cross-dom-bridge-eth.mdx(3 hunks)
✅ Files skipped from review due to trivial changes (2)
- nouns.txt
- pages/builders/app-developers/tutorials/_meta.json
🧰 Additional context used
📓 Path-based instructions (1)
pages/builders/app-developers/tutorials/cross-dom-bridge-eth.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.
"
🔇 Additional comments (2)
pages/builders/app-developers/tutorials/cross-dom-bridge-eth.mdx (2)
2-2: LGTM: Title properly capitalizes "Viem"
The title follows the proper noun capitalization guidelines.
9-9: LGTM: Headers follow sentence case guidelines
The headers consistently use sentence case while properly capitalizing technical terms and proper nouns.
Also applies to: 48-48, 95-95
sbvegan
approved these changes
Nov 1, 2024
This was referenced Nov 7, 2024
This was referenced Dec 1, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.