relocate crosschain directory #1361
Conversation
cpengilly
commented
Feb 12, 2025
cpengilly
commented
- collapse crosschain folder into stack/interop
- sim link just the tutorials to app-devs/tutorials
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe changes reorganize the documentation for crosschain functionalities. A "Crosschain guides" card has been removed from both the app developers and stack interop sections. In its place, three new tutorial cards have been added that focus on making crosschain contract calls (ping pong), performing crosschain event reads (tic-tac-toe), and deploying crosschain event composability (contests). Corresponding metadata in JSON files has been updated to reflect these additions. Additionally, the interop security page has been revised with updated titles and descriptions, while legacy crosschain documentation pages and metadata have been removed. A series of URL redirects in the public configuration have been updated to point to the new locations of these resources, thereby streamlining the documentation structure. Possibly related PRs
Suggested labels
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: 2
🔭 Outside diff range comments (4)
pages/stack/interop.mdx (1)
2-3: 💡 Verification agent🧩 Analysis chain
Ensure proper capitalization of technical terms in the description.
The description contains several technical terms that should be properly capitalized according to our documentation standards:
- "Cross Chain Message"
- "Message Passing"
- "OP Supervisor"
- "Superchain ERC20"
- "Superchain WETH"
- "SuperSim"
Please verify the correct capitalization of these terms against the
nouns.txtfile:
🏁 Script executed:
#!/bin/bash # Description: Check capitalization in nouns.txt rg -i "cross.?chain|message.?passing|supervisor|erc20|weth|supersim" nouns.txtLength of output: 133
Correct Capitalization for Technical Terms in the MDX Description
- The MDX description currently contains "Superchain Erc20", but the nouns file specifies the correct form as "SuperchainERC20" (without a space).
- Similarly, while "Supersim" in the file is correct, please double-check if "Superchain Weth" should follow a similar concatenated pattern (e.g., "SuperchainWETH") according to documentation guidelines.
- For terms like "Cross Chain Message", "Message Passing", and "OP Supervisor" that do not appear in the nouns file, verify—against the technical documentation guidelines—whether their current formatting meets the intended style.
pages/stack/interop/tutorials/event-reads.mdx (3)
22-22: 🛠️ Refactor suggestionFix typos in the explanation.
The sentence contains two typos:
- We use events to define the ordering of the a game with players only maintaining a local view. By default, a chain is also apart of its own interopble dependency set, which means players on the same chain can also play each other **with no code changes**! + We use events to define the ordering of a game with players only maintaining a local view. By default, a chain is also a part of its own interoperable dependency set, which means players on the same chain can also play each other **with no code changes**!🧰 Tools
🪛 LanguageTool
[grammar] ~22-~22: Two determiners in a row. Choose either “the” or “a”.
Context: ...We use events to define the ordering of the a game with players only maintaining a lo...(DT_DT)
[uncategorized] ~22-~22: Possible missing comma found.
Context: ... events to define the ordering of the a game with players only maintaining a local v...(AI_HYDRA_LEO_MISSING_COMMA)
37-37: 🛠️ Refactor suggestionFix typo in game identifier explanation.
- A game is uniquely identified by the chain it was started from with a unqiue nonce. + A game is uniquely identified by the chain it was started from with a unique nonce.🧰 Tools
🪛 LanguageTool
[misspelling] ~37-~37: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...d by the chain it was started from with a unqiue nonce. This identifier is includ...(EN_A_VS_AN)
106-106: 🛠️ Refactor suggestionFix typo in validation explanation.
- The event fields contain the information required to perform the neccessary validation. + The event fields contain the information required to perform the necessary validation.
🧹 Nitpick comments (2)
pages/stack/interop.mdx (2)
11-11: Remove duplicate description.The description on line 11 is identical to the one in the frontmatter. Consider removing this duplicate content to maintain DRY principles.
-Documentation covering Cross Chain Message, Explainer, Message Passing, Op Supervisor, Superchain Erc20, Superchain Weth, Supersim, Transfer Superchainerc20 in the Interop section of the OP Stack ecosystem.
14-36: Apply consistent title case for card titles.Several card titles need proper title case according to our documentation standards:
- "Interoperability Explainer"
- "Interop Message Passing Overview"
- "OP Supervisor"
- "SuperSim Multichain Development Environment"
- "Interop Devnet"
- "Interoperability Predeploys"
- "Interop Assets"
- "SuperchainERC20"
- "SuperchainWETH (Interoperable ETH)"
- "Safe Interoperability Measures"
Please verify the correct capitalization against the
nouns.txtfile:✅ Verification successful
🏁 Script executed:
#!/bin/bash # Description: Check capitalization in nouns.txt rg -i "interop|supersim|erc20|weth|eth" nouns.txtLength of output: 113
Enforce consistent title case for card titles.
Based on our review and the capitalization rules defined in our documentation (with nouns like “Supersim” and “SuperchainERC20” verified against the
nouns.txtfile), please update the card titles in pages/stack/interop.mdx as follows:
- Change "Interoperability explainer" to "Interoperability Explainer".
- Change "Interop message passing overview" to "Interop Message Passing Overview".
- Ensure "OP Supervisor" remains as is.
- Change "Supersim multichain development environment" to "Supersim Multichain Development Environment"
(note: thenouns.txtfile confirms the spelling as “Supersim”).- Change "Interop devnet" to "Interop Devnet".
- Change "Interoperability predeploys" to "Interoperability Predeploys".
- Change "Interop assets" to "Interop Assets".
- Ensure "SuperchainERC20" remains unchanged.
- Ensure "SuperchainWETH (Interoperable ETH)" remains unchanged.
- Change "Safe interoperability measures" to "Safe Interoperability Measures".
This update will bring the titles in line with our documentation standards.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (18)
pages/app-developers/get-started.mdx(0 hunks)pages/app-developers/tutorials/interop.mdx(1 hunks)pages/app-developers/tutorials/interop/_meta.json(1 hunks)pages/app-developers/tutorials/interop/contract-calls.mdx(1 hunks)pages/app-developers/tutorials/interop/event-contests.mdx(1 hunks)pages/app-developers/tutorials/interop/event-reads.mdx(1 hunks)pages/stack/interop.mdx(1 hunks)pages/stack/interop/_meta.json(1 hunks)pages/stack/interop/cross-chain.mdx(0 hunks)pages/stack/interop/cross-chain/_meta.json(0 hunks)pages/stack/interop/interop-security.mdx(2 hunks)pages/stack/interop/tools/devnet.mdx(1 hunks)pages/stack/interop/tutorials.mdx(1 hunks)pages/stack/interop/tutorials/_meta.json(1 hunks)pages/stack/interop/tutorials/contract-calls.mdx(1 hunks)pages/stack/interop/tutorials/event-contests.mdx(1 hunks)pages/stack/interop/tutorials/event-reads.mdx(2 hunks)public/_redirects(1 hunks)
💤 Files with no reviewable changes (3)
- pages/app-developers/get-started.mdx
- pages/stack/interop/cross-chain.mdx
- pages/stack/interop/cross-chain/_meta.json
✅ Files skipped from review due to trivial changes (8)
- pages/stack/interop/_meta.json
- pages/app-developers/tutorials/interop/contract-calls.mdx
- pages/stack/interop/tools/devnet.mdx
- pages/app-developers/tutorials/interop/event-contests.mdx
- pages/app-developers/tutorials/interop/event-reads.mdx
- pages/stack/interop/interop-security.mdx
- pages/stack/interop/tutorials/contract-calls.mdx
- pages/stack/interop/tutorials/event-contests.mdx
🧰 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/stack/interop/tutorials.mdxpages/stack/interop.mdxpages/stack/interop/tutorials/event-reads.mdxpages/app-developers/tutorials/interop.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 (4)
public/_redirects (1)
100-104: LGTM! The redirects are properly structured.The new redirects for crosschain documentation are correctly configured and align with the PR's objective of relocating the crosschain directory under stack/interop.
pages/app-developers/tutorials/interop/_meta.json (1)
7-9: LGTM! The metadata entries are well-structured.The new entries for crosschain tutorials maintain consistent formatting and provide clear, descriptive titles.
pages/stack/interop/tutorials/_meta.json (1)
7-9: LGTM! The metadata entries are consistent.The new entries for crosschain tutorials maintain consistency with their counterparts in the app-developers section.
pages/stack/interop/tutorials.mdx (1)
24-28: LGTM! The tutorial cards are properly formatted.The new cards for crosschain tutorials maintain consistent formatting, use appropriate title case, and correctly link to their respective tutorials.
1 participant
