Skip to content

Refactor RPC page to create Superchain RPC directory #1590

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

Merged
merged 18 commits into from
Apr 29, 2025
Merged

Conversation

krofax
Copy link
Collaborator

@krofax krofax commented Apr 29, 2025

Description

This PR creates a comprehensive Superchain RPC Directory by refactoring the existing RPC & Node providers page. The directory now includes public RPC endpoints for all Green/Yellow Superchain networks and details which production RPC providers support each network.

Changes:

  • Renamed page to "Superchain RPC Directory"
  • Added tabs to organize Mainnet and Testnet public RPC endpoints
  • Listed all Superchain networks with their public RPC URLs and documentation links
  • Updated provider information to show specific Superchain network support
  • Added directory governance information
  • Updated metadata for better categorization

Tests

Additional context

Metadata

Copy link

netlify bot commented Apr 29, 2025

Deploy Preview for docs-optimism ready!

Name Link
🔨 Latest commit 2864716
🔍 Latest deploy log https://app.netlify.com/sites/docs-optimism/deploys/68111df9cfaab30008b5b5db
😎 Deploy Preview https://deploy-preview-1590--docs-optimism.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@krofax krofax marked this pull request as ready for review April 29, 2025 14:01
@krofax krofax requested review from 0xmariniere and a team as code owners April 29, 2025 14:01
Copy link
Contributor

coderabbitai bot commented Apr 29, 2025

📝 Walkthrough

Walkthrough

This set of changes restructures and broadens the documentation related to RPC providers and chain operator deployment within the project. The "RPC & Node providers" documentation was renamed and expanded into a "Superchain RPC directory," now covering all Superchain networks rather than only Optimism. The content was reorganized to use a tabbed table format for public endpoints, added a uniform section for production RPC providers, and introduced a governance policy for directory maintenance. The metadata and introductory descriptions were updated accordingly. Additionally, the deployment landing page for chain operators and its associated metadata file were deleted, and the corresponding navigation card was removed from the chain operators landing page. The words.txt file saw three words removed and three new words added, with no changes to its structure.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Docs_Site
    participant RPC_Directory

    User->>Docs_Site: Navigate to Superchain RPC directory
    Docs_Site->>RPC_Directory: Display tabbed public endpoints (Mainnets/Testnets)
    User->>Docs_Site: View production RPC providers section
    Docs_Site->>User: Show uniform provider list with supported networks
    User->>Docs_Site: Read directory governance and next steps
Loading

Possibly related PRs

  • Update rpc-providers.mdx #1052: Adds a single new provider section (Blockdaemon) to the older, Optimism-specific RPC providers document, whereas this PR restructures and expands the entire document into a Superchain-wide directory.
  • feat : add and update rpc-providers #1524: Adds a new RPC provider entry within the previously Optimism-focused RPC providers document, while this PR subsumes and extends the scope to all Superchain networks.
  • Added Getblock RPC Details #1106: Adds a specific new section for GetBlock within the older Optimism-focused RPC providers document, but this PR reorganizes and supersedes that content in a broader, unified directory.

Suggested reviewers

  • cpengilly
  • zainbacchus
  • sbvegan

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 40472e7 and f504c39.

📒 Files selected for processing (1)
  • pages/operators/chain-operators/deploy.mdx (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • pages/operators/chain-operators/deploy.mdx

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🔭 Outside diff range comments (1)
pages/app-developers/tools/connect/rpc-providers.mdx (1)

210-212: 🛠️ Refactor suggestion

Use title case for link text.
Link texts for page names should use Title Case. Please update:

  • [Node operators guide][Node Operators Guide]
  • [developer tools overview][Developer Tools Overview]
🧹 Nitpick comments (3)
pages/operators/chain-operators/deploy/validate-deployment.mdx (3)

125-125: H2 header should use sentence case
According to our header style guide, only the first word in an H2 should be capitalized (unless it’s a proper noun). Please change

## Next Steps

to

## Next steps

127-128: Ensure consistent punctuation in Next Steps bullets
The first bullet ends with a period but the second one does not. For consistency, please add a period at the end of the second bullet.


109-116: Improve table readability by consolidating multi-line descriptions
Splitting a single description across multiple rows with blank cells may render inconsistently. Consider merging each error code and its full description into one row, for example:

| ERROR           | DESCRIPTION                                                             |
| --------------- | ----------------------------------------------------------------------- |
| PDDG-40         | Permissioned dispute game absolute prestate mismatch                   |
| PDDG-ANCHORP-40 | Permissioned dispute game anchor state registry root hash mismatch     |
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 78a9fcb and 4913f98.

📒 Files selected for processing (6)
  • pages/app-developers/tools/connect/_meta.json (1 hunks)
  • pages/app-developers/tools/connect/rpc-providers.mdx (1 hunks)
  • pages/operators/chain-operators/deploy.mdx (1 hunks)
  • pages/operators/chain-operators/deploy/_meta.json (1 hunks)
  • pages/operators/chain-operators/deploy/validate-deployment.mdx (1 hunks)
  • words.txt (4 hunks)
🧰 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:
    1. 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]
    ---
    1. 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]
    ---
    1. If any required fields are missing or empty, comment:
      'This file appears to be missing required metadata. Please check keywords.config.yaml for valid options and add the required fields manually. You can validate your changes by running:
    pnpm validate-metadata
    ```'
  • 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:
    1. Use sentence case, capitalizing only the first word.
    2. 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.
    3. 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/operators/chain-operators/deploy.mdx
  • pages/operators/chain-operators/deploy/validate-deployment.mdx
  • pages/app-developers/tools/connect/rpc-providers.mdx
🪛 LanguageTool
words.txt

[duplication] ~197-~197: Možný preklep: zopakovali ste slovo
Context: ...b lightkdf Lisk logfile logfmt Mainnets MAXAGE maxage MAXBACKUPS maxbackups MAXPEERS maxpeers...

(WORD_REPEAT_RULE)


[duplication] ~279-~279: Možný preklep: zopakovali ste slovo
Context: ...tack outfile Pausability pcscdpath PDDG Pectra pectra Pectra's Peerstore peerstore peerstores...

(WORD_REPEAT_RULE)


[duplication] ~404-~404: Možný preklep: zopakovali ste slovo
Context: ...uperlend Superloans Superscan Superseed Supersim supersim SYNCMODE syncmode SYNCTARGET synctarget...

(WORD_REPEAT_RULE)

🔇 Additional comments (4)
pages/app-developers/tools/connect/_meta.json (1)

3-3: Approve updated navigation label.
The key "rpc-providers" label has been correctly updated to reflect the retitled page.

pages/app-developers/tools/connect/rpc-providers.mdx (1)

20-20: Skip: import is required.
The Tabs component import matches its usage below.

pages/operators/chain-operators/deploy/_meta.json (1)

4-5: Approve metadata extension.
The new "genesis" and "validate-deployment" entries correctly map to the added deployment guides, keeping navigation metadata consistent.

words.txt (1)

17-17: Approve vocabulary updates.
The additions of "ANCHORP", "Mainnets", "PDDG", and "Superseed" align with the updated documentation terminology.

Also applies to: 197-197, 279-279, 404-404

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

♻️ Duplicate comments (2)
pages/app-developers/tools/connect/rpc-providers.mdx (2)

2-2: Frontmatter title should use Title Case.

Per documentation guidelines, the title field in the frontmatter must follow Title Case. Please update it to:

title: Superchain RPC Directory

22-22: H1 heading should use sentence case.

Per style guide, H1 headings use sentence case (capitalize only the first word and proper nouns). Please change:

- # Superchain RPC Directory
+ # Superchain RPC directory
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4913f98 and 99d24e4.

📒 Files selected for processing (2)
  • pages/app-developers/tools/connect/rpc-providers.mdx (1 hunks)
  • words.txt (5 hunks)
🧰 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:
    1. 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]
    ---
    1. 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]
    ---
    1. If any required fields are missing or empty, comment:
      'This file appears to be missing required metadata. Please check keywords.config.yaml for valid options and add the required fields manually. You can validate your changes by running:
    pnpm validate-metadata
    ```'
  • 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:
    1. Use sentence case, capitalizing only the first word.
    2. 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.
    3. 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/tools/connect/rpc-providers.mdx
🪛 LanguageTool
words.txt

[duplication] ~197-~197: Možný preklep: zopakovali ste slovo
Context: ...b lightkdf Lisk logfile logfmt Mainnets MAXAGE maxage MAXBACKUPS maxbackups MAXPEERS maxpeers...

(WORD_REPEAT_RULE)


[duplication] ~255-~255: Možný preklep: zopakovali ste slovo
Context: ...y NODEKEYHEX nodekeyhex nodename Nodies NODISCOVER nodiscover NOLOCALS nolocals NOPREFETCH noprefetch...

(WORD_REPEAT_RULE)


[duplication] ~280-~280: Možný preklep: zopakovali ste slovo
Context: ...tack outfile Pausability pcscdpath PDDG Pectra pectra Pectra's Peerstore peerstore peerstores...

(WORD_REPEAT_RULE)


[duplication] ~405-~405: Možný preklep: zopakovali ste slovo
Context: ...uperlend Superloans Superscan Superseed Supersim supersim SYNCMODE syncmode SYNCTARGET synctarget...

(WORD_REPEAT_RULE)

⏰ 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 (5)
words.txt (5)

17-17: Approve addition of 'ANCHORP'.

The new acronym entry ‘ANCHORP’ aligns with the naming conventions for service acronyms in this list.


197-197: Approve addition of 'Mainnets'.

Adding the plural ‘Mainnets’ clarifies references to multiple main-chain networks, matching the expanded Superchain scope.

🧰 Tools
🪛 LanguageTool

[duplication] ~197-~197: Možný preklep: zopakovali ste slovo
Context: ...b lightkdf Lisk logfile logfmt Mainnets MAXAGE maxage MAXBACKUPS maxbackups MAXPEERS maxpeers...

(WORD_REPEAT_RULE)


255-255: Approve addition of 'Nodies'.

The colloquial plural ‘Nodies’ follows the pattern of similar entries (e.g., ‘Bootnodes’, ‘Superchainerc’).

🧰 Tools
🪛 LanguageTool

[duplication] ~255-~255: Možný preklep: zopakovali ste slovo
Context: ...y NODEKEYHEX nodekeyhex nodename Nodies NODISCOVER nodiscover NOLOCALS nolocals NOPREFETCH noprefetch...

(WORD_REPEAT_RULE)


280-280: Approve addition of 'PDDG'.

The uppercase acronym ‘PDDG’ is consistent with other protocol or gateway abbreviations.

🧰 Tools
🪛 LanguageTool

[duplication] ~280-~280: Možný preklep: zopakovali ste slovo
Context: ...tack outfile Pausability pcscdpath PDDG Pectra pectra Pectra's Peerstore peerstore peerstores...

(WORD_REPEAT_RULE)


405-405: Approve addition of 'Superseed'.

Including ‘Superseed’ supports the new Superchain service naming and fits the list’s format.

🧰 Tools
🪛 LanguageTool

[duplication] ~405-~405: Možný preklep: zopakovali ste slovo
Context: ...uperlend Superloans Superscan Superseed Supersim supersim SYNCMODE syncmode SYNCTARGET synctarget...

(WORD_REPEAT_RULE)

@zainbacchus
Copy link
Contributor

Are we able to use the URLs that are in the Google Doc for the 2nd table?

Networks link helps reviewers confirm the future PRs have the relevant networks supported
Paid plans link helps teams easily compare pricing

@zainbacchus
Copy link
Contributor

Can we update "To be listed, providers must maintain a free public endpoint" to "To be listed, providers must support at least one network in the Superchain[link to registry]"

Copy link
Contributor

@coderabbitai coderabbitai bot left a 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

♻️ Duplicate comments (3)
pages/app-developers/tools/connect/rpc-providers.mdx (3)

2-2: Frontmatter title should use title case.
Per documentation guidelines, frontmatter titles must follow Title Case. Please update to:

title: Superchain RPC Directory

22-22: Header should use sentence case.
Per style guide, H1 headings must use sentence case. Please change to:

# Superchain RPC directory

248-249: Link text should use Title Case.
Per guidelines, link text should follow Title Case. Please update to:

- See the [Node operators guide](/operators/node-operators/rollup-node).
+ See the [Node Operators Guide](/operators/node-operators/rollup-node).

- See [developer tools overview](/app-developers/tools) to explore more options!
+ See [Developer Tools Overview](/app-developers/tools) to explore more options!
🧹 Nitpick comments (2)
pages/app-developers/tools/connect/rpc-providers.mdx (2)

19-19: Remove or utilize the Callout import.
The Callout component is imported but not used in this file. Consider removing it or using it to highlight important information (for example, the rate-limit warning).


28-28: Avoid bold for emphasis; use a callout instead.
The phrase “rate-limited and not suitable for production use” is styled in bold, which conflicts with the guideline to avoid bold for emphasis. Consider replacing it with a warning callout:

<Callout type="warning">
  These endpoints are rate-limited and not suitable for production use.
</Callout>
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2696649 and 40472e7.

📒 Files selected for processing (1)
  • pages/app-developers/tools/connect/rpc-providers.mdx (1 hunks)
🧰 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:
    1. 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]
    ---
    1. 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]
    ---
    1. If any required fields are missing or empty, comment:
      'This file appears to be missing required metadata. Please check keywords.config.yaml for valid options and add the required fields manually. You can validate your changes by running:
    pnpm validate-metadata
    ```'
  • 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:
    1. Use sentence case, capitalizing only the first word.
    2. 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.
    3. 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/tools/connect/rpc-providers.mdx
🔇 Additional comments (7)
pages/app-developers/tools/connect/rpc-providers.mdx (7)

4-4: Approve frontmatter description.
The description field is present, non-empty, and concisely summarizes the page's purpose.


11-15: Approve frontmatter categories.
The categories array is populated with relevant, non-empty values that align with the page’s scope.


20-20: Approve import of Tabs component.
The Tabs component is correctly imported and will be used to organize Mainnet and Testnet sections.


24-24: Approve introductory paragraph.
The updated introduction clearly reflects the broadened scope of the directory for all Superchain networks.


31-31: Approve use of tabbed interface.
Utilizing the Tabs component to separate Mainnet and Testnet endpoints significantly improves content navigability.


81-81: Approve production RPC providers section heading.
The “Production RPC providers” heading clearly introduces the production-grade provider list in correct sentence case.


243-243: Approve updated governance criteria.
The governance section now explicitly links to the Superchain registry and clearly defines listing requirements.

Copy link
Collaborator

@sbvegan sbvegan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Zain says lgtm, so let's ship it (once the ci is passing lol)

@krofax krofax merged commit bba53f8 into main Apr 29, 2025
12 checks passed
@krofax krofax deleted the refactor-rpc-page branch April 29, 2025 18:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants