Skip to content
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

Update rpc-providers.mdx #1052

Merged
merged 2 commits into from
Oct 31, 2024
Merged

Update rpc-providers.mdx #1052

merged 2 commits into from
Oct 31, 2024

Conversation

kwijayabd
Copy link
Contributor

@kwijayabd kwijayabd commented Oct 31, 2024

Description
Added Blockdaemon to the RPC & Node providers list.

Tests

Additional context

Metadata

Added Blockdaemon to the RPC & Node providers list.
@kwijayabd kwijayabd requested review from 0xmariniere and a team as code owners October 31, 2024 09:58
Copy link

netlify bot commented Oct 31, 2024

Deploy Preview for docs-optimism ready!

Name Link
🔨 Latest commit 72dde8e
🔍 Latest deploy log https://app.netlify.com/sites/docs-optimism/deploys/6723bbbb26aebb00084c53f7
😎 Deploy Preview https://deploy-preview-1052--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.

Copy link
Contributor

coderabbitai bot commented Oct 31, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces a new section for "Blockdaemon" in the "RPC & Node providers" guide within the rpc-providers.mdx file. This section details Blockdaemon's services, including its institutional-grade blockchain infrastructure and premium RPC offerings, specifically highlighting support for the OP Mainnet. Users are provided with a link to sign up for a free Blockdaemon account. The overall structure of the document remains unchanged, with existing provider sections unaffected.

Changes

File Path Change Summary
pages/builders/tools/connect/rpc-providers.mdx Added a new section for "Blockdaemon" including description, pricing, and supported networks (OP Mainnet).
words.txt Added entries for "Blockdaemon," "Blockdaemon's," "Sepolia," and "zora"; updated casing for consistency.

Possibly related issues

Possibly related PRs

  • Add Chainstack to RPC providers #754: This PR adds a new section for Chainstack in the same rpc-providers.mdx file, similar to the addition of Blockdaemon.
  • Deploy section #729: Although this PR focuses on deployment configurations, it is part of the broader context of RPC and node providers, which aligns with the main PR's updates to the RPC providers documentation.
  • Create Granite notice page skeleton #870: This PR introduces a new notice page for the Granite upgrade, which may relate to the overall documentation structure that includes RPC providers, although it does not directly modify the same files.
  • feat: docs for sendRawTranscationConditional #956: This PR enhances documentation for the sendRawTransactionConditional method, which is relevant to RPC functionalities, similar to the RPC services described in the main PR.
  • Op deployer updates #1020: This PR updates the op-deployer documentation, which is relevant to the deployment and configuration aspects of the OP Stack, aligning with the RPC provider context in the main PR.

Suggested reviewers

  • cpengilly
  • bradleycamacho

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?

❤️ 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 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: 0

🧹 Outside diff range and nitpick comments (2)
pages/builders/tools/connect/rpc-providers.mdx (2)

43-45: Consider using more neutral language in the description.

The current description contains marketing-heavy language. Consider revising to:

-Blockdaemon provides institutional-grade blockchain infrastructure, including node, staking, and API solutions, with premium RPC services optimized for [Optimism](https://docs.blockdaemon.com/reference/how-to-access-optimism-api). With free and enhanced options, Blockdaemon's RPC API allows developers to securely interact with on-chain data, broadcast transactions, and build dApps with minimal setup, offering streamlined access to enriched blockchain data and 99.9% uptime reliability to meet diverse needs.
+Blockdaemon provides blockchain infrastructure services, including node operations, staking, and API solutions, with RPC services for [Optimism](https://docs.blockdaemon.com/reference/how-to-access-optimism-api). The service offers both free and enhanced tiers, enabling developers to interact with on-chain data, broadcast transactions, and build dApps. Features include enriched blockchain data access and a guaranteed uptime SLA of 99.9%.

47-47: Standardize the sign-up link format.

For consistency with other provider sections (e.g., Infura), consider revising to:

-[Sign up for a free Blockdaemon account here](https://app.blockdaemon.com/signin/register)
+[Sign up for a free Blockdaemon account](https://app.blockdaemon.com/signin/register)
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 8131990 and 46c29ad.

📒 Files selected for processing (1)
  • pages/builders/tools/connect/rpc-providers.mdx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
pages/builders/tools/connect/rpc-providers.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:
    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.
    "
🔇 Additional comments (2)
pages/builders/tools/connect/rpc-providers.mdx (2)

41-42: LGTM!

The section header follows proper capitalization rules for proper nouns.


49-51: LGTM!

The supported networks section follows the established format consistently.

@krofax krofax merged commit b42466b into ethereum-optimism:main Oct 31, 2024
5 of 6 checks passed
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.

2 participants