Update outdated docs

[DZakh]

Summary by CodeRabbit

• New Features

  • Added rate limiting configuration option for effects (5 calls per second).
  • Expanded blockchain support to include SVM-compatible networks.
  • Added new networks to HyperSync supported networks list.

• Documentation

  • Updated API examples and feature descriptions for clarity.
  • Improved performance metrics (10,000+ events per second for historical backfills).
  • Refined wording across feature documentation.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[vercel]

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

Project	Deployment	Review	Updated (UTC)
envio-docs	Ready	Preview, Comment	Dec 19, 2025 10:28am

[coderabbitai]

Walkthrough

This PR updates documentation across multiple guides to reflect API changes: renaming experimental_createEffect to createEffect and adding rateLimit configuration options. Feature descriptions in the overview are revised for clarity, and network support tables are expanded with new entries.

Changes

Cohort / File(s)	Summary
Effect API documentation updates docs/HyperIndex/Advanced/preload-optimization.md, docs/HyperIndex/Guides/contract-state.md, docs/HyperIndex/Guides/event-handlers.mdx, docs/HyperIndex/Guides/ipfs.md	Replaced experimental_createEffect import and usage with createEffect, and added rateLimit configuration (5 calls per second) to effect definitions in code examples.
Overview documentation docs/HyperIndex/overview.md	Revised feature bullet descriptions for improved clarity and consistency, including updated phrasing, capitalization, and performance metrics (e.g., "10,000 events per second," expanded network support to include "EVM-, SVM-, or Fuel-compatible").
Network support tables docs/HyperSync/hypersync-supported-networks.md	Added new network entries to the supported networks table, expanding the list of available networks.
Formatting adjustment docs/HyperRPC/hyperrpc-supported-networks.md	Added blank line before network table header.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Changes follow consistent patterns across documentation files (homogeneous API rename and configuration additions)
• Majority of edits are documentation updates and wording refinements with straightforward verification
• Network table expansion is additive content with no logic changes

Possibly related PRs

• enviodev/docs#675 — Adds a cache option to experimental_createEffect; overlaps with this PR's API changes and may require reconciliation.
• enviodev/docs#734 — Directly related; also replaces experimental_createEffect with createEffect and adds rateLimit option in the same documentation snippets.
• enviodev/docs#685 — Modifies Effect API documentation and examples with the same experimental_createEffect → createEffect transition.

Suggested reviewers

• moose-code
• DenhamPreen

Poem

🐰 The docs hop forward with a rename so fine,
From experimental to stable—a mark of design!
Rate limits now throttle our external calls,
While features are polished in overview's halls,
A network or two added, all tidy and neat—
Documentation's refresh is ever so sweet! 🌟

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'Update outdated docs' is vague and generic, using non-descriptive terminology that doesn't convey specific information about what documentation was updated or why.	Use a more specific title that describes the main changes, such as 'Replace experimental_createEffect with createEffect and add rateLimit configuration' or 'Update HyperIndex documentation and add network entries.'

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch dz/update-outdated-parts

---

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4861df3 and d5ced63.

📒 Files selected for processing (7)

• docs/HyperIndex/Advanced/preload-optimization.md (2 hunks)
• docs/HyperIndex/Guides/contract-state.md (2 hunks)
• docs/HyperIndex/Guides/event-handlers.mdx (1 hunks)
• docs/HyperIndex/Guides/ipfs.md (3 hunks)
• docs/HyperIndex/overview.md (1 hunks)
• docs/HyperRPC/hyperrpc-supported-networks.md (1 hunks)
• docs/HyperSync/hypersync-supported-networks.md (1 hunks)

🧰 Additional context used

🧠 Learnings (1)

📚 Learning: 2025-07-29T14:30:03.677Z

Learnt from: DenhamPreen
Repo: enviodev/docs PR: 673
File: docs/HyperIndex/supported-networks/chainweb-testnet-21.md:14-16
Timestamp: 2025-07-29T14:30:03.677Z
Learning: Chainweb Testnet 20 (ID: 5920) and Chainweb Testnet 21 (ID: 5921) have non-functional HyperSync endpoints that return HTTP 404, indicating these networks are not properly supported and should be removed from documentation.

Applied to files:

• docs/HyperRPC/hyperrpc-supported-networks.md
• docs/HyperSync/hypersync-supported-networks.md

🪛 markdownlint-cli2 (0.18.1)

docs/HyperSync/hypersync-supported-networks.md

49-49: Bare URL used

(MD034, no-bare-urls)

---

49-49: Bare URL used

(MD034, no-bare-urls)

🔇 Additional comments (8)

docs/HyperRPC/hyperrpc-supported-networks.md (1)

41-41: LGTM! Minor formatting improvement.

The additional blank line before the network table improves readability.

docs/HyperSync/hypersync-supported-networks.md (1)

49-49: LGTM! Formatting improvement.

The blank line improves visual separation before the network table, consistent with the HyperRPC documentation.

docs/HyperIndex/Guides/event-handlers.mdx (1)

473-488: LGTM! API updated to stable version.

The update from experimental_createEffect to createEffect reflects the API graduation from experimental to stable. The addition of rateLimit configuration provides helpful rate limiting guidance for external calls.

docs/HyperIndex/Advanced/preload-optimization.md (1)

103-118: LGTM! Consistent API updates.

The changes correctly update the API from experimental_createEffect to createEffect and add the rateLimit configuration, consistent with other documentation updates in this PR.

docs/HyperIndex/Guides/ipfs.md (2)

131-185: LGTM! API updated with rate limiting.

The update to createEffect and the addition of rateLimit configuration are applied correctly to the IPFS metadata fetching example.

---

283-291: LGTM! Caching example updated consistently.

The second instance of getIpfsMetadata (demonstrating caching) is updated with the same API changes, maintaining consistency across the guide.

docs/HyperIndex/Guides/contract-state.md (1)

193-226: LGTM! Token metadata effect updated.

The getTokenMetadata effect correctly transitions from experimental_createEffect to createEffect with appropriate rate limiting configuration, consistent with the broader API update.

docs/HyperIndex/overview.md (1)

33-47: LGTM! Feature descriptions improved.

The updated feature descriptions are clearer and more concise, improving the overall readability of the overview while maintaining accuracy.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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