Skip to content

Update hyperindex-complete.mdx#825

Merged
Jordy-Baby merged 1 commit intomainfrom
Jordy-Baby-patch-10
Mar 20, 2026
Merged

Update hyperindex-complete.mdx#825
Jordy-Baby merged 1 commit intomainfrom
Jordy-Baby-patch-10

Conversation

@Jordy-Baby
Copy link
Copy Markdown
Collaborator

@Jordy-Baby Jordy-Baby commented Mar 20, 2026

Summary by CodeRabbit

  • Documentation
    • Updated initialization command syntax and API token requirements information
    • Enhanced Quick Links with direct Markdown format for improved navigation
    • Streamlined supported networks documentation

@Jordy-Baby Jordy-Baby requested a review from keenbeen32 March 20, 2026 08:42
@vercel
Copy link
Copy Markdown

vercel bot commented Mar 20, 2026

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

Project Deployment Actions Updated (UTC)
envio-docs Building Building Preview, Comment Mar 20, 2026 8:42am

Request Review

@Jordy-Baby Jordy-Baby enabled auto-merge (squash) March 20, 2026 08:42
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 20, 2026

📝 Walkthrough

Walkthrough

Documentation updates to the HyperIndex LLM guide, including restructuring the Key Facts section from table to bullet list, converting Quick Links to explicit Markdown links, updating command references, and removing sections for three supported networks (Aleph Zero EVM, Altlayer OP Demo Testnet, Ancient8).

Changes

Cohort / File(s) Summary
Documentation Updates
docs/HyperIndex-LLM/hyperindex-complete.mdx
Restructured Key Facts from table to bullet list with wording adjustments (pnpx envio initnpx envio init, "GraphQL APIs" → "GraphQL"), converted Quick Links to explicit Markdown links with updated URLs, removed three supported network sections (Aleph Zero EVM, Altlayer OP Demo Testnet, Ancient8) and associated documentation, deleted trailing separator before FAQ section.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Suggested reviewers

  • nikbhintade
  • keenbeen32

Poem

🐰 A bunny hops through docs so neat,
Reorganizing, making them complete,
Quick links now shine with URL light,
Key facts in lists, oh what a sight!
Networks pruned, the guide feels right. ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title is vague and generic. 'Update hyperindex-complete.mdx' merely states that a file was modified without conveying what the meaningful changes are or why they matter. Consider a more descriptive title that highlights the main changes, such as 'Update HyperIndex docs: simplify Key Facts, add Quick Links, and remove network support sections' or similar.
✅ 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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch Jordy-Baby-patch-10
📝 Coding Plan
  • Generate coding plan for human review comments

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.

Copy link
Copy Markdown
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: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/HyperIndex-LLM/hyperindex-complete.mdx`:
- Around line 17-49: The generated hyperindex-complete.mdx is being edited
directly but is overwritten by the consolidation script; update the source docs
or the consolidation script instead of editing this file. Open
consolidate-hyperindex-docs.js and either (a) make your content change in the
original docs under the HyperIndex source directory referenced by the
consolidation routine, then run the consolidation to regenerate
hyperindex-complete.mdx, or (b) if this content must be preserved in generation,
modify the consolidation logic in consolidate-hyperindex-docs.js (the
consolidation block that merges source docs and supported-network coverage) to
include/patch the specific info permanently before it writes
hyperindex-complete.mdx. Ensure you do not leave manual edits in
hyperindex-complete.mdx.
- Line 45: Standardize the init command by choosing one canonical form (either
"npx envio init" or "pnpx envio init") and replace every occurrence in the
document where "npx envio init" or "pnpx envio init" appears (e.g., the instance
shown as "npx envio init") so all sections use the same command string; ensure
you update all matches consistently (case-sensitive) throughout the file.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: f4aeb4d8-ca3e-4577-b7f2-7bfce0b058fa

📥 Commits

Reviewing files that changed from the base of the PR and between ae2afe4 and 1402548.

📒 Files selected for processing (1)
  • docs/HyperIndex-LLM/hyperindex-complete.mdx

Comment on lines +17 to 49
:::info Key Facts

- **What it is:** A blazing fast, developer friendly multichain blockchain indexer that transforms onchain events into structured, queryable data via GraphQL

- **Data engine:** Powered by HyperSync with up to 2000x faster performance than traditional RPC endpoints

- **Performance:** Ranked #1 fastest indexer in independent Sentio benchmarks (April 2025), up to 6x faster than the nearest competitor and 63x faster than The Graph

- **Supported chains:** 70+ EVM chains and Fuel, with new networks added regularly. All EVM compatible chains supported via RPC

- **Languages:** TypeScript, JavaScript, ReScript

- **Key files:** config.yaml (indexer config), schema.graphql (data schema), src/EventHandlers.* (event logic)

- **Prerequisites:** Node.js v22+, pnpm v8+, Docker Desktop (local dev only)

- **Deployment:** Hosted service (managed, no API token needed) or self hosted

- **API token:** Required for local dev and self hosted deployments via ENVIO_API_TOKEN env variable (from 3 November 2025)

- **Query interface:** Auto generated GraphQL API from your schema

- **Multichain:** Native multichain indexing with unordered_multichain_mode support

- **Wildcard indexing:** Index by event signature instead of contract address

- **Migration:** Straightforward migration path from The Graph subgraphs

- **Get started:** npx envio init

- **Support:** [Discord](https://discord.gg/envio) and [GitHub](https://github.com/enviodev)

:::
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Avoid manual edits in the generated consolidation output.

Lines in this section are being edited directly in docs/HyperIndex-LLM/hyperindex-complete.mdx, but this file is regenerated by scripts/consolidate-hyperindex-docs.js (see scripts/consolidate-hyperindex-docs.js:208-240). These edits are likely to be overwritten on the next consolidation run, including content coverage changes from supported-network sources (scripts/consolidate-hyperindex-docs.js:327-345).

Please apply content changes in source docs under docs/HyperIndex/** (or adjust the consolidation script), then regenerate this file.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/HyperIndex-LLM/hyperindex-complete.mdx` around lines 17 - 49, The
generated hyperindex-complete.mdx is being edited directly but is overwritten by
the consolidation script; update the source docs or the consolidation script
instead of editing this file. Open consolidate-hyperindex-docs.js and either (a)
make your content change in the original docs under the HyperIndex source
directory referenced by the consolidation routine, then run the consolidation to
regenerate hyperindex-complete.mdx, or (b) if this content must be preserved in
generation, modify the consolidation logic in consolidate-hyperindex-docs.js
(the consolidation block that merges source docs and supported-network coverage)
to include/patch the specific info permanently before it writes
hyperindex-complete.mdx. Ensure you do not leave manual edits in
hyperindex-complete.mdx.


- **Migration:** Straightforward migration path from The Graph subgraphs

- **Get started:** npx envio init
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Standardize init command usage across this doc.

Line 45 uses npx envio init, while multiple other sections in the same file still instruct pnpx envio init (e.g., Line 134, Line 2627, Line 2824, Line 3016, Line 3336, Line 6938). Pick one canonical command and align all occurrences to avoid user confusion.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/HyperIndex-LLM/hyperindex-complete.mdx` at line 45, Standardize the init
command by choosing one canonical form (either "npx envio init" or "pnpx envio
init") and replace every occurrence in the document where "npx envio init" or
"pnpx envio init" appears (e.g., the instance shown as "npx envio init") so all
sections use the same command string; ensure you update all matches consistently
(case-sensitive) throughout the file.

@Jordy-Baby Jordy-Baby merged commit 1c8585f into main Mar 20, 2026
3 checks passed
@Jordy-Baby Jordy-Baby deleted the Jordy-Baby-patch-10 branch March 20, 2026 10:08
This was referenced Mar 26, 2026
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