Update integration-apis.rst#576
Conversation
Add GetBlock to API Services
📝 WalkthroughWalkthroughThis PR adds a new GetBlock API provider section to the developer integration APIs documentation. The change includes the provider's website link, feature description covering JSON-RPC, REST, and Blockbook support, pricing information for free and paid tiers, and a reference to external documentation. ChangesGetBlock API Provider Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~5 minutes 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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. Comment Warning |
There was a problem hiding this comment.
🧹 Nitpick comments (2)
docs/user/developers/integration-apis.rst (2)
115-128: ⚡ Quick winAdd an image for visual consistency.
The GetBlock section lacks a provider logo/image, while all other API provider sections in this document include one (Insight, BlockCypher, BitGo, Blockmove, NOWNodes, Tokenview, CoinPayments). Adding an image would maintain visual consistency and improve the user experience.
📸 Suggested image directive to add
Add the following between line 116 and line 117:
.. image:: img/getblock.png :width: 200px :align: right :target: https://getblock.io/Note: You'll need to obtain and add the GetBlock logo image file to
docs/user/developers/img/getblock.png.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/user/developers/integration-apis.rst` around lines 115 - 128, Add the GetBlock provider image directive to the GetBlock section so it matches other provider entries: insert an RST image directive referencing the provider logo (e.g., the same pattern used in sections for Insight/BlockCypher) pointing to img/getblock.png with :width: 200px, :align: right and :target: https://getblock.io/ and ensure the image file is added to docs/user/developers/img/getblock.png; update the GetBlock block in integration-apis.rst (the "GetBlock" section) to include this directive above the description.
125-126: 💤 Low valueImprove hyphenation in pricing model description.
The phrase "paid shared- and dedicated-node pricing" uses awkward suspended hyphenation that may confuse readers.
✍️ Suggested rewording
-- Pricing Model: Free up to 50K CUs, paid shared- and dedicated-node -pricing +- Pricing Model: Free up to 50K CUs, paid shared-node and dedicated-node +pricingAlternatively, you could simplify to "paid shared and dedicated node pricing" if the hyphenation doesn't add clarity.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@docs/user/developers/integration-apis.rst` around lines 125 - 126, Update the phrasing "paid shared- and dedicated-node pricing" in the docs to remove the awkward suspended hyphenation; locate the exact string and replace it with either "paid shared- and dedicated-node pricing" corrected to "paid shared and dedicated-node pricing" if you want to keep the compound "dedicated-node", or simpler "paid shared and dedicated node pricing" for clarity and consistency with surrounding copy; ensure the replacement occurs where the phrase appears in the integration-apis.rst content.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@docs/user/developers/integration-apis.rst`:
- Around line 115-128: Add the GetBlock provider image directive to the GetBlock
section so it matches other provider entries: insert an RST image directive
referencing the provider logo (e.g., the same pattern used in sections for
Insight/BlockCypher) pointing to img/getblock.png with :width: 200px, :align:
right and :target: https://getblock.io/ and ensure the image file is added to
docs/user/developers/img/getblock.png; update the GetBlock block in
integration-apis.rst (the "GetBlock" section) to include this directive above
the description.
- Around line 125-126: Update the phrasing "paid shared- and dedicated-node
pricing" in the docs to remove the awkward suspended hyphenation; locate the
exact string and replace it with either "paid shared- and dedicated-node
pricing" corrected to "paid shared and dedicated-node pricing" if you want to
keep the compound "dedicated-node", or simpler "paid shared and dedicated node
pricing" for clarity and consistency with surrounding copy; ensure the
replacement occurs where the phrase appears in the integration-apis.rst content.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 05633707-5cce-4495-91bf-b7993c7ad037
📒 Files selected for processing (1)
docs/user/developers/integration-apis.rst
Add GetBlock to API Services
Preview build: https://dash-docs--576.org.readthedocs.build/en/576/
Summary by CodeRabbit