Skip to content

Conversation

@nikbhintade
Copy link
Member

@nikbhintade nikbhintade commented Oct 24, 2025

Summary by CodeRabbit

  • Documentation
    • Added guidance on configuring RPC fallback providers for improved resilience and high availability.
    • Reorganized Advanced HyperIndex documentation sections for improved clarity.
    • Updated HyperSync client initialization URL.
    • Fixed documentation cross-references.

@vercel
Copy link

vercel bot commented Oct 24, 2025

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

Project Deployment Preview Comments Updated (UTC)
envio-docs Ready Ready Preview Comment Oct 24, 2025 6:30am

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 24, 2025

Walkthrough

This PR reorganizes RPC fallback documentation by moving content from the hypersync.md file to rpc-sync.md, updates related hyperlinks to reference the new location, and corrects a HyperSync client initialization URL endpoint in example code.

Changes

Cohort / File(s) Change Summary
RPC Fallback Documentation Relocation
docs/HyperIndex/Advanced/hypersync.md, docs/HyperIndex/Advanced/rpc-sync.md
Removed RPC fallback resilience section from hypersync.md and added new "Improving resilience with RPC fallback" subsection to rpc-sync.md with configuration guidance, benefits, example config, and version info (2.14.0). Section titles renamed for clarity ("Availability and Support" → "Hosting and Support", "Alternatives" → "Alternative Data Sources").
Documentation Link Updates
docs/HyperIndex/overview.md
Updated hyperlink target for "Fallback RPC data sources" from /docs/HyperIndex/hypersync#improving-resilience-with-rpc-fallback to /docs/HyperIndex/rpc-sync#improving-resilience-with-rpc-fallback.
HyperSync Client URL Endpoint
docs/HyperSync/hypersync-usage.md
Changed HyperSync client initialization URL from https://ethereum.hypersync.xyz to https://eth.hypersync.xyz in the complete example.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

These are entirely documentation changes—content reorganization, link updates, and a URL endpoint correction—with no code logic or functional behavior modifications. The changes are straightforward and consistent in nature.

Possibly related PRs

  • HyperIndex v2.21 #631: Introduces RPC fallback feature documentation and related config schema changes; both PRs address RPC fallback content and configuration.

Suggested reviewers

  • moose-code
  • DenhamPreen

Poem

🐰 Links hop to their rightful place,
RPC fallbacks find new space,
Endpoints dance from old to new,
Docs spring clean—refreshed and true!
🌟

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The PR title "moving fallback RPC section & hypersyc url change" directly addresses the two main changes in the changeset: relocating the "Improving resilience with RPC fallback" section from hypersync.md to rpc-sync.md, and updating the HyperSync client initialization URL from ethereum.hypersync.xyz to eth.hypersync.xyz. The title is concise, avoids noise, and clearly communicates what was done without being overly broad or generic. Although there is a minor typo ("hypersyc" instead of "hypersync"), the title remains clear and accurately summarizes the primary changes.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch nb/docs-fix

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 nikbhintade changed the title chore: moved fallback rpc section to correct page & hypersyc url change Reorg pages & hypersyc url change Oct 24, 2025
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think it makes sense to move this here.

The rpc as a fallback is mostly to address a hypersync issue, so in my mind, it's more something that's shown for when you're reading the hypersync source doc.

Copy link
Member Author

Choose a reason for hiding this comment

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

@moose-code thought it was somewhat confusing that this section was under hypersync. Since RPC fallback is more closely related to RPC as a data source, I moved that section to where it felt like a better fit. Also, having all RPC-related things in one place is better.

Copy link
Contributor

Choose a reason for hiding this comment

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

I don't agree. I think it's important for users understanding HyperSync to know that there is an option for an RPC fallback.

I am happy to be overruled here. I would suggest that you ask JJ to review this PR.

client = hypersync.HypersyncClient(
hypersync.ClientConfig(
url="https://ethereum.hypersync.xyz",
url="https://eth.hypersync.xyz",
Copy link
Contributor

Choose a reason for hiding this comment

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

nice!

@DenhamPreen
Copy link
Contributor

The pr title says reorg pages, do you mean rpc fallback or is there something missing from this pr

@nikbhintade nikbhintade changed the title Reorg pages & hypersyc url change Reorg fallback section & hypersyc url change Oct 24, 2025
@nikbhintade nikbhintade changed the title Reorg fallback section & hypersyc url change moving fallback RPC section & hypersyc url change Oct 24, 2025
@nikbhintade
Copy link
Member Author

@DenhamPreen I wanted to say reorganization of that particular section, not the pages. I have updated the title to "moving fallback RPC section"

Copy link
Contributor

@moose-code moose-code left a comment

Choose a reason for hiding this comment

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

@nikbhintade going to preapprove but just ask you add a small section back in the hypersync side that points towards this so users will find this if they look in hypersync or rpc

@nikbhintade
Copy link
Member Author

yeah, I will add that section

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.

4 participants