-
Notifications
You must be signed in to change notification settings - Fork 264
fixing redirect to superchain explainer #1502
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThis pull request introduces a new redirect entry in the Sequence Diagram(s)sequenceDiagram
participant User as User
participant Server as Server
User->>Server: Request /stack/explainer
Server-->>User: Redirect to /superchain/superchain-explainer
Possibly related PRs
Suggested labels
Suggested reviewers
Tip ⚡🧪 Multi-step agentic review comment chat (experimental)
🪧 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
|
Will be updating this some valid github urls..... |
Yeah I see Bella's full spreadsheet now, sorry for hoping in late here |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (2)
pages/app-developers/tools/build/oracles.mdx (1)
140-142
: Refine RedStone Oracle description
The updates to the RedStone Core, Classic, and Hybrid model links are correctly implemented. However, the description in the Hybrid model line (line 142) can be improved for clarity. Consider rephrasing to include a determiner and verb for better readability. For example:-* [Hybrid (push + push) ERC7412](https://docs.redstone.finance/docs/dapps/redstone-erc7412/) - specifically for Perps and Options, highest update frequency and front-running protection. +* [Hybrid (push + push) ERC7412](https://docs.redstone.finance/docs/dapps/redstone-erc7412/) - specifically designed for Perps and Options, providing the highest update frequency and front-running protection.This small refinement addresses the static analysis hint regarding a missing determiner.
🧰 Tools
🪛 LanguageTool
[grammar] ~142-~142: A determiner may be missing.
Context: ...) - specifically for Perps and Options, highest update frequency and front-running prot...(THE_SUPERLATIVE)
pages/app-developers/tools/build/ecosystem-overview.mdx (1)
32-33
: Refined Cards labels and formatting
The card titles have been updated to "Superchain Interop " and "viem-optimism" to better reflect the content focus. Consider removing the trailing whitespace in the first card’s title to ensure consistency and avoid potential display issues. For example:- <Card title="Superchain Interop " href="https://github.com/ethereum-optimism/ecosystem/tree/a309bfd496f5072a64ce154204e5f72f56fe8163/packages/viem/src/actions/interop" icon={<img src="/img/icons/shapes.svg" />} /> + <Card title="Superchain Interop" href="https://github.com/ethereum-optimism/ecosystem/tree/a309bfd496f5072a64ce154204e5f72f56fe8163/packages/viem/src/actions/interop" icon={<img src="/img/icons/shapes.svg" />} />This small change will ensure all card titles are formatted uniformly.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
pages/app-developers/tools/build/block-explorers.mdx
(0 hunks)pages/app-developers/tools/build/ecosystem-overview.mdx
(1 hunks)pages/app-developers/tools/build/oracles.mdx
(2 hunks)pages/connect/contribute/stack-contribute.mdx
(1 hunks)pages/stack/getting-started.mdx
(1 hunks)pages/stack/interop/superchain-weth.mdx
(1 hunks)
💤 Files with no reviewable changes (1)
- pages/app-developers/tools/build/block-explorers.mdx
✅ Files skipped from review due to trivial changes (2)
- pages/connect/contribute/stack-contribute.mdx
- pages/stack/interop/superchain-weth.mdx
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with the following criteria: - First, check the frontmatter section at the top of the file: 1. For regular pages, ensure AL...
**/*.mdx
: "ALWAYS review Markdown content THOROUGHLY with the following criteria:
- First, check the frontmatter section at the top of the file:
- For regular pages, ensure ALL these fields are present and not empty:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] personas: [non-empty array] categories: [non-empty array] content_type: [valid type] ---
- For landing pages (index.mdx or files with ), only these fields are required:
--- title: [non-empty] lang: [non-empty] description: [non-empty] topic: [non-empty] ---
- If any required fields are missing or empty, comment:
'This file appears to be missing required metadata. You can fix this by running:Review the changes, then run without :dry to apply them.'pnpm metadata-batch-cli:dry "path/to/this/file.mdx"
- 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/getting-started.mdx
pages/app-developers/tools/build/oracles.mdx
pages/app-developers/tools/build/ecosystem-overview.mdx
🪛 LanguageTool
pages/app-developers/tools/build/oracles.mdx
[grammar] ~142-~142: A determiner may be missing.
Context: ...) - specifically for Perps and Options, highest update frequency and front-running prot...
(THE_SUPERLATIVE)
🔇 Additional comments (5)
pages/app-developers/tools/build/oracles.mdx (1)
79-79
: Updated API3 price feeds link
The URL for the API3 price feeds has been correctly updated to the new endpoint (https://docs.api3.org/oev-searchers/in-depth/#dapps-catalog
). This change improves navigation and aligns with the current documentation structure.pages/stack/getting-started.mdx (1)
68-68
: Updated hyperlink for Design Principles
The hyperlink now includes a leading slash, ensuring it correctly resolves as an absolute path (i.e./stack/design-principles
). This update improves routing consistency across the documentation.pages/app-developers/tools/build/ecosystem-overview.mdx (3)
22-23
: Enhanced repository description
The updated description of the Superchain ecosystem repository clearly outlines its purpose and benefits for OP Stack developers. The wording effectively conveys the repository’s role, and the inclusion of the link to GitHub is correct.
27-27
: Bridge tutorial link update
The revised sentence describing the bridge tutorial now provides a specific reference (/stack/interop/tutorials/bridge-crosschain-eth
) that improves clarity on how to build bridges. This aligns well with the overall documentation goals.
29-29
: Highlighting the viem-optimism utility package
The additional text emphasizing the [viem-optimism] package offers developers a clear pointer to essential utilities for interacting with the OP Stack. This update is informative and useful.
Description
Tests
Additional context
Metadata