update callout #1348
Merged
update callout #1348
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
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request updates several documentation pages by adding a new 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: 0
🧹 Nitpick comments (8)
pages/stack/interop/tutorials/deploy-superchain-erc20.mdx (1)
10-13: Improve the callout message style and consistency.The message is technically accurate but can be improved:
<Callout> The SuperchainERC20 standard is ready for production use with active Mainnet deployments. -Please note that the OP Stack interoperability upgrade, required for crosschain messaging, is currently still in active development. +The OP Stack interoperability upgrade, required for cross-chain messaging, is currently in active development. </Callout>pages/stack/interop/tutorials/transfer-superchainERC20.mdx (1)
9-12: Improve the callout message style and consistency.The message should follow the same improvements as other files:
<Callout> The SuperchainERC20 standard is ready for production use with active Mainnet deployments. -Please note that the OP Stack interoperability upgrade, required for crosschain messaging, is currently still in active development. +The OP Stack interoperability upgrade, required for cross-chain messaging, is currently in active development. </Callout>pages/stack/interop/superchain-erc20.mdx (1)
9-12: Improve the callout message style and consistency.The message should follow the same improvements as other files:
<Callout> The SuperchainERC20 standard is ready for production use with active Mainnet deployments. -Please note that the OP Stack interoperability upgrade, required for crosschain messaging, is currently still in active development. +The OP Stack interoperability upgrade, required for cross-chain messaging, is currently in active development. </Callout>pages/app-developers/starter-kit.mdx (1)
11-14: Improve the callout message style and consistency.The message should follow the same improvements as other files:
<Callout> The SuperchainERC20 standard is ready for production use with active Mainnet deployments. -Please note that the OP Stack interoperability upgrade, required for crosschain messaging, is currently still in active development. +The OP Stack interoperability upgrade, required for cross-chain messaging, is currently in active development. </Callout>pages/stack/interop/tutorials/relay-messages-viem.mdx (1)
10-13: Improve the callout message style and consistency.The message should follow the same improvements as other files:
<Callout> The SuperchainERC20 standard is ready for production use with active Mainnet deployments. -Please note that the OP Stack interoperability upgrade, required for crosschain messaging, is currently still in active development. +The OP Stack interoperability upgrade, required for cross-chain messaging, is currently in active development. </Callout>pages/stack/interop/tutorials/relay-messages-cast.mdx (3)
2-2: Update header capitalization.Update the title to capitalize the proper noun "Interop":
-title: Relaying interop messages using `cast` +title: Relaying Interop messages using `cast`
186-186: Maintain professional tone in documentation.Consider rephrasing to maintain a more professional tone:
-This is obviously very tedious to do by hand 😅. Here are some alternatives: +Manually relaying messages can be time-consuming. Here are some alternatives:
188-189: Ensure consistent punctuation in list items.Add periods at the end of list items for consistency:
-* use `supersim --interop.autorelay` - this only works on supersim, but relayers for the testnet/prod environment will be available soon! -* [use `viem` bindings/actions](relay-using-viem.md) - if you're using typescript, we have bindings available to make fetching identifiers and relaying messages easy +* Use `supersim --interop.autorelay` - this only works on supersim, but relayers for the testnet/prod environment will be available soon. +* [Use `viem` bindings/actions](relay-using-viem.md) - if you're using TypeScript, we have bindings available to make fetching identifiers and relaying messages easy.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
pages/app-developers/starter-kit.mdx(1 hunks)pages/stack/interop/superchain-erc20.mdx(1 hunks)pages/stack/interop/tutorials/deploy-superchain-erc20.mdx(1 hunks)pages/stack/interop/tutorials/relay-messages-cast.mdx(1 hunks)pages/stack/interop/tutorials/relay-messages-viem.mdx(1 hunks)pages/stack/interop/tutorials/transfer-superchainERC20.mdx(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with ...
**/*.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/app-developers/starter-kit.mdxpages/stack/interop/tutorials/deploy-superchain-erc20.mdxpages/stack/interop/superchain-erc20.mdxpages/stack/interop/tutorials/relay-messages-cast.mdxpages/stack/interop/tutorials/relay-messages-viem.mdxpages/stack/interop/tutorials/transfer-superchainERC20.mdx
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
- GitHub Check: pr-workflow
🔇 Additional comments (1)
pages/stack/interop/tutorials/relay-messages-cast.mdx (1)
10-13: LGTM! Clear and informative callout.The callout effectively communicates the current status of SuperchainERC20 and OP Stack interoperability with proper capitalization of technical terms.
krofax
approved these changes
Feb 11, 2025
This was referenced Feb 11, 2025
This was referenced Feb 20, 2025
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.
update callout for superchainerc20 pages