Skip to content

Block Handler Docs Updated#731

Closed
nikbhintade wants to merge 3 commits intomainfrom
nb/block-handler-docs-update
Closed

Block Handler Docs Updated#731
nikbhintade wants to merge 3 commits intomainfrom
nb/block-handler-docs-update

Conversation

@nikbhintade
Copy link
Member

@nikbhintade nikbhintade commented Nov 10, 2025

Summary by CodeRabbit

  • Documentation
    • Reorganized HyperSync documentation structure for improved clarity.
    • Added new guidance on improving resilience with RPC fallback configuration.
    • Updated API endpoint URL for HyperSync client configuration.
    • Clarified onBlock API use cases in documentation.

@vercel
Copy link

vercel bot commented Nov 10, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
envio-docs Building Building Preview Comment Nov 10, 2025 8:17am

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 10, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

The PR reorganizes RPC fallback documentation by consolidating it into a dedicated RPC-sync section, updates cross-references between guides, refines the onBlock API description, and changes a HyperSync endpoint URL from ethereum.hypersync.xyz to eth.hypersync.xyz.

Changes

Cohort / File(s) Summary
RPC fallback documentation reorganization
docs/HyperIndex/Advanced/hypersync.md, docs/HyperIndex/Advanced/rpc-sync.md
Removes RPC fallback content from HyperSync guide and consolidates it into RPC-sync section with new subsection "Improving resilience with RPC fallback," including fallback configuration examples, benefits, and version availability notes.
Cross-reference updates
docs/HyperIndex/overview.md
Updates documentation link path for RPC fallback from HyperSync section to RPC-sync section.
API endpoint change
docs/HyperSync/hypersync-usage.md
Changes HyperSync client configuration endpoint URL from https://ethereum.hypersync.xyz to https://eth.hypersync.xyz.
API description refinement
docs/HyperIndex/Guides/block-handlers.md
Updates onBlock API introductory description to remove "bulk updates using raw SQL" reference and emphasize "aggregations and time-series logic."

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

  • Documentation-only changes with straightforward content reorganization
  • Cross-file link verification needed to ensure all references resolve correctly
  • Endpoint URL change should be validated against current infrastructure

Possibly related issues

Possibly related PRs

  • HyperIndex v2.21 #631: Overlaps with RPC documentation additions and new rpc configuration schema modifications in the same feature area.

Suggested reviewers

  • DenhamPreen
  • moose-code

Poem

🐰 Docs hop and scatter, then settle just right,
RPC fallbacks find their new light,
From HyperSync paths to dedicated places,
eth.hypersync.xyz takes its new places! 🔄
A shuffle of links, a dance most refined,
Documentation's harmony, perfectly designed.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch nb/block-handler-docs-update

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ef001df and 66dc847.

📒 Files selected for processing (5)
  • docs/HyperIndex/Advanced/hypersync.md (1 hunks)
  • docs/HyperIndex/Advanced/rpc-sync.md (1 hunks)
  • docs/HyperIndex/Guides/block-handlers.md (1 hunks)
  • docs/HyperIndex/overview.md (1 hunks)
  • docs/HyperSync/hypersync-usage.md (1 hunks)

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@nikbhintade
Copy link
Member Author

this is not correct PR

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.

1 participant