Moved interop tutorials to their own directory #1253
Conversation
Also, removed the assets directory, it is no longer needed
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThis pull request involves updates to the documentation metadata and redirect paths within the Optimism/Superchain ecosystem. Key changes include the removal of the "assets" key from the Possibly related PRs
Suggested reviewers
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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
🧹 Nitpick comments (1)
pages/stack/interop/_meta.json (1)
6-8: Verify naming consistency in Superchain-related entries.Note the inconsistent casing in
superchainerc20-best-practicescompared to other Superchain entries. Consider standardizing to match the format used insuperchain-erc20andsuperchain-weth.- "superchainerc20-best-practices": "SuperchainERC20 best practices", + "superchain-erc20-best-practices": "SuperchainERC20 best practices",
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
pages/stack/interop/_meta.json(1 hunks)pages/stack/interop/assets/_meta.json(0 hunks)pages/stack/interop/tutorials/_meta.json(1 hunks)public/_redirects(1 hunks)
💤 Files with no reviewable changes (1)
- pages/stack/interop/assets/_meta.json
✅ Files skipped from review due to trivial changes (1)
- pages/stack/interop/tutorials/_meta.json
🔇 Additional comments (2)
public/_redirects (1)
118-120: Ensure tutorial redirects align with the new directory structure.The tutorial-related redirects have been consolidated under the
/stack/interop/tutorials/path. This aligns well with the new metadata structure in_meta.json.pages/stack/interop/_meta.json (1)
10-11: LGTM! Good organization of documentation sections.The addition of separate sections for tools and tutorials provides a clear structure for different types of content.
|
The |
|
@qbzzt @bradleycamacho @sbvegan lets just nuke Re the piece on deterministic addresses we can add back into the SuperchainERC20 explainer or tutorial when we get there |
The one relevant best practice moved to the erc20 explainer
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
pages/stack/interop/superchain-erc20.mdx (1)
74-74: Apply sentence case to section headerAccording to the documentation guidelines, H2 headers should use sentence case. Please update the header to:
-## Consistent addresses across chains +## Consistent addresses across chains
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
pages/stack/interop/_meta.json(1 hunks)pages/stack/interop/superchain-erc20.mdx(1 hunks)public/_redirects(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- pages/stack/interop/_meta.json
🧰 Additional context used
📓 Path-based instructions (1)
pages/stack/interop/superchain-erc20.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/stack/interop/superchain-erc20.mdx
[uncategorized] ~76-~76: The preposition “at” seems more likely in this position.
Context: ...rrespond to the tokens that were burned on source. Consider using `Create2Deploye...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - docs-optimism
- GitHub Check: Header rules - docs-optimism
- GitHub Check: Pages changed - docs-optimism
🔇 Additional comments (3)
public/_redirects (3)
115-116: LGTM: Asset paths correctly moved to top levelThe redirects properly handle the migration of Superchain assets from the
/assets/subdirectory to the top level of the interop section, aligning with the PR objectives.
117-119: LGTM: Tutorial paths correctly organizedThe redirects appropriately move the tutorials to a dedicated
/tutorials/directory, maintaining a clean separation of content types.
120-120: Verify the target path existsPlease ensure that the target path
/stack/interop/superchain-erc20exists to prevent 404 errors.#!/bin/bash # Description: Verify the existence of the target path fd -t f "superchain-erc20\.(md|mdx)$" pages/stack/interop/
Consider it done. I still need to go over the ERC20 doc, but that's for a different PR. |
4 participants
public/_redirects.