Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughThis PR updates documentation links across blog posts and guides to reflect a reorganized documentation structure, adds new supported network pages for Ab, Arc Testnet, and Sentient networks, updates HyperRPC and HyperSync supported networks tables with seven new network entries, and restructures Arc Testnet documentation from RPC-focused to Envio-centric content. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Areas requiring extra attention:
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
docs/HyperSync/hypersync-supported-networks.md (1)
52-53: Remove non-functional Chainweb Testnet networks from supported list.According to documented learnings, 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. These entries should be removed from the supported networks documentation to prevent developer frustration.
Consider removing these lines as part of fixing broken links in this PR.
docs/HyperRPC/hyperrpc-supported-networks.md (1)
44-45: Remove non-functional Chainweb Testnet networks from supported list.Chainweb Testnet 20 (ID: 5920) and Chainweb Testnet 21 (ID: 5921) have non-functional HyperRPC endpoints that return HTTP 404. These should be removed from documentation to prevent broken developer experience, especially in a PR focused on fixing broken links.
Consider removing these lines to align with the PR's objective.
🧹 Nitpick comments (7)
docs/unused/example-aave-token.md (1)
19-19: Link update looks good, but consider improving link text for accessibility.The prerequisites link has been correctly updated to the new HyperIndex getting-started path. However, using "here" as link text is not descriptive and can impact accessibility for screen reader users.
Consider this more descriptive alternative:
-1. Install any other pre-requisite packages for Envio listed [here](https://docs.envio.dev/docs/HyperIndex/getting-started#prerequisites) +1. Install any other [pre-requisite packages for Envio](https://docs.envio.dev/docs/HyperIndex/getting-started#prerequisites)docs/HyperIndex/Examples/example-ens.md (1)
18-18: Link update looks good, but consider improving link text for accessibility.The prerequisites link has been correctly updated. However, using "here" as link text is not descriptive and can impact accessibility for screen reader users.
Consider this more descriptive alternative:
-2. Install any other pre-requisite packages for Envio listed [here](https://docs.envio.dev/docs/HyperIndex/getting-started#prerequisites) +2. Install any other [pre-requisite packages for Envio](https://docs.envio.dev/docs/HyperIndex/getting-started#prerequisites)docs/unused/example-erc4626-token-vault.md (1)
21-21: Improve link text for accessibility and SEO.The link text "[here]" is non-descriptive. Use more specific text like "here" or inline it descriptively (e.g., "listed here" becomes "see prerequisites").
-1. Install any other pre-requisite packages for Envio listed [here](https://docs.envio.dev/docs/HyperIndex/getting-started#prerequisites) +1. Install any other pre-requisite packages for Envio listed in the [prerequisites guide](https://docs.envio.dev/docs/HyperIndex/getting-started#prerequisites)Verify the destination URL
https://docs.envio.dev/docs/HyperIndex/getting-started#prerequisitesexists and correctly anchors to the prerequisites section.docs/unused/example-reNFT.md (1)
19-19: Improve link text for accessibility and SEO.The link text "[here]" is non-descriptive. Consider using more specific anchor text.
-1. Install any other pre-requisite packages for Envio listed [here](https://docs.envio.dev/docs/HyperIndex/getting-started#prerequisites) +1. Install any other pre-requisite packages for Envio listed in the [prerequisites guide](https://docs.envio.dev/docs/HyperIndex/getting-started#prerequisites)Verify the destination URL is accessible and correctly anchors to prerequisites.
docs/HyperIndex/Examples/example-liquidation-metrics.md (1)
38-38: Improve link text for clarity and SEO.The link text "[here]" is non-descriptive. Provide more meaningful anchor text to help users and search engines understand the link destination.
-2. Install any other pre-requisite packages for Envio listed [here](https://docs.envio.dev/docs/HyperIndex/getting-started#prerequisites) +2. Install any other pre-requisite packages for Envio listed in the [prerequisites guide](https://docs.envio.dev/docs/HyperIndex/getting-started#prerequisites)Confirm the destination URL
https://docs.envio.dev/docs/HyperIndex/getting-started#prerequisitesis valid and contains the referenced content.docs/unused/example-on-chain-governance.md (1)
21-21: Improve link text for accessibility and SEO.The link text "[here]" lacks description. Use more specific text.
-1. Install any other pre-requisite packages for Envio listed [here](https://docs.envio.dev/docs/HyperIndex/getting-started#prerequisites) +1. Install any other pre-requisite packages for Envio listed in the [prerequisites guide](https://docs.envio.dev/docs/HyperIndex/getting-started#prerequisites)Verify the destination URL is valid and contains the prerequisites section.
blog/2024-08-13-case-study-sablier.md (1)
57-57: Improve link text to be descriptive.The link text "[here]" is non-descriptive and flagged by linting (MD059). Provide meaningful anchor text.
-For more information on Envio's multi-chain indexing capabilities, view our dev docs [here](https://docs.envio.dev/docs/HyperIndex/multichain-indexing). +For more information on Envio's multi-chain indexing capabilities, view the [multi-chain indexing guide](https://docs.envio.dev/docs/HyperIndex/multichain-indexing).Verify the destination URL
https://docs.envio.dev/docs/HyperIndex/multichain-indexingexists and is correct.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (27)
blog/2023-10-26-envio-community-update-3.md(1 hunks)blog/2024-01-31-envio-community-update-6.md(1 hunks)blog/2024-02-12-envio-azuro-developer-grant-multi-chain-open-source-indexer.md(1 hunks)blog/2024-02-20-envio-data-indexing-on-lukso.md(1 hunks)blog/2024-03-01-envio-community-update-7.md(1 hunks)blog/2024-03-27-envio-community-update-8.md(1 hunks)blog/2024-03-27-envio-data-indexing-on-harmony.md(1 hunks)blog/2024-04-22-envio-hypersync-powers-data-access-on-fuel-network.md(2 hunks)blog/2024-05-08-envio-community-update-9.md(1 hunks)blog/2024-05-24-case-study-peppy-finance.md(1 hunks)blog/2024-05-30-envio-community-update-may-2024.md(1 hunks)blog/2024-07-17-case-study-gblast.md(1 hunks)blog/2024-07-18-data-indexing-on-fuel.md(1 hunks)blog/2024-08-13-case-study-sablier.md(2 hunks)docs/HyperIndex/Examples/example-ens.md(1 hunks)docs/HyperIndex/Examples/example-liquidation-metrics.md(1 hunks)docs/HyperIndex/supported-networks/ab.md(1 hunks)docs/HyperIndex/supported-networks/arc-testnet.md(1 hunks)docs/HyperIndex/supported-networks/sentient.md(1 hunks)docs/HyperRPC/hyperrpc-supported-networks.md(2 hunks)docs/HyperSync/hypersync-query.md(1 hunks)docs/HyperSync/hypersync-supported-networks.md(2 hunks)docs/unused/example-aave-token.md(1 hunks)docs/unused/example-erc4626-token-vault.md(1 hunks)docs/unused/example-on-chain-governance.md(1 hunks)docs/unused/example-reNFT.md(1 hunks)docusaurus.config.js(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
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.
📚 Learning: 2025-07-29T14:32:31.665Z
Learnt from: DenhamPreen
Repo: enviodev/docs PR: 673
File: LLM_DOCS_README.md:24-32
Timestamp: 2025-07-29T14:32:31.665Z
Learning: The Envio documentation build system requires Yarn and does not work with pnpm, despite other parts of the repository potentially using pnpm/pnpx. The LLM documentation commands (yarn build-llm, yarn start-llm, yarn consolidate-docs) must remain using yarn to function properly.
Applied to files:
docs/unused/example-aave-token.mddocs/unused/example-erc4626-token-vault.mddocs/unused/example-reNFT.mddocs/unused/example-on-chain-governance.mddocs/HyperIndex/Examples/example-liquidation-metrics.mddocs/HyperIndex/Examples/example-ens.md
📚 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/HyperIndex/supported-networks/arc-testnet.mddocs/HyperRPC/hyperrpc-supported-networks.mddocs/HyperSync/hypersync-supported-networks.mdblog/2024-01-31-envio-community-update-6.md
🪛 LanguageTool
blog/2024-03-27-envio-data-indexing-on-harmony.md
[grammar] ~29-~29: Use a hyphen to join words.
Context: ...pc)** is a hyper-speed Ethereum RPC (RPC formatted endpoint based on HyperSync’s ...
(QB_NEW_EN_HYPHEN)
🪛 markdownlint-cli2 (0.18.1)
docs/unused/example-aave-token.md
19-19: Link text should be descriptive
(MD059, descriptive-link-text)
blog/2024-02-12-envio-azuro-developer-grant-multi-chain-open-source-indexer.md
84-84: Bare URL used
(MD034, no-bare-urls)
docs/unused/example-erc4626-token-vault.md
21-21: Link text should be descriptive
(MD059, descriptive-link-text)
docs/unused/example-reNFT.md
19-19: Link text should be descriptive
(MD059, descriptive-link-text)
blog/2024-08-13-case-study-sablier.md
57-57: Link text should be descriptive
(MD059, descriptive-link-text)
docs/unused/example-on-chain-governance.md
21-21: Link text should be descriptive
(MD059, descriptive-link-text)
docs/HyperRPC/hyperrpc-supported-networks.md
26-26: Bare URL used
(MD034, no-bare-urls)
26-26: Bare URL used
(MD034, no-bare-urls)
27-27: Bare URL used
(MD034, no-bare-urls)
27-27: Bare URL used
(MD034, no-bare-urls)
28-28: Bare URL used
(MD034, no-bare-urls)
28-28: Bare URL used
(MD034, no-bare-urls)
29-29: Bare URL used
(MD034, no-bare-urls)
29-29: Bare URL used
(MD034, no-bare-urls)
30-30: Bare URL used
(MD034, no-bare-urls)
30-30: Bare URL used
(MD034, no-bare-urls)
31-31: Bare URL used
(MD034, no-bare-urls)
31-31: Bare URL used
(MD034, no-bare-urls)
32-32: Bare URL used
(MD034, no-bare-urls)
32-32: Bare URL used
(MD034, no-bare-urls)
33-33: Bare URL used
(MD034, no-bare-urls)
33-33: Bare URL used
(MD034, no-bare-urls)
34-34: Bare URL used
(MD034, no-bare-urls)
34-34: Bare URL used
(MD034, no-bare-urls)
35-35: Bare URL used
(MD034, no-bare-urls)
35-35: Bare URL used
(MD034, no-bare-urls)
36-36: Bare URL used
(MD034, no-bare-urls)
36-36: Bare URL used
(MD034, no-bare-urls)
37-37: Bare URL used
(MD034, no-bare-urls)
37-37: Bare URL used
(MD034, no-bare-urls)
38-38: Bare URL used
(MD034, no-bare-urls)
38-38: Bare URL used
(MD034, no-bare-urls)
39-39: Bare URL used
(MD034, no-bare-urls)
39-39: Bare URL used
(MD034, no-bare-urls)
40-40: Bare URL used
(MD034, no-bare-urls)
40-40: Bare URL used
(MD034, no-bare-urls)
96-96: Bare URL used
(MD034, no-bare-urls)
96-96: Bare URL used
(MD034, no-bare-urls)
docs/HyperIndex/Examples/example-ens.md
18-18: Link text should be descriptive
(MD059, descriptive-link-text)
docs/HyperSync/hypersync-supported-networks.md
34-34: Bare URL used
(MD034, no-bare-urls)
34-34: Bare URL used
(MD034, no-bare-urls)
35-35: Bare URL used
(MD034, no-bare-urls)
35-35: Bare URL used
(MD034, no-bare-urls)
36-36: Bare URL used
(MD034, no-bare-urls)
36-36: Bare URL used
(MD034, no-bare-urls)
37-37: Bare URL used
(MD034, no-bare-urls)
37-37: Bare URL used
(MD034, no-bare-urls)
38-38: Bare URL used
(MD034, no-bare-urls)
38-38: Bare URL used
(MD034, no-bare-urls)
39-39: Bare URL used
(MD034, no-bare-urls)
39-39: Bare URL used
(MD034, no-bare-urls)
40-40: Bare URL used
(MD034, no-bare-urls)
40-40: Bare URL used
(MD034, no-bare-urls)
41-41: Bare URL used
(MD034, no-bare-urls)
41-41: Bare URL used
(MD034, no-bare-urls)
42-42: Bare URL used
(MD034, no-bare-urls)
42-42: Bare URL used
(MD034, no-bare-urls)
43-43: Bare URL used
(MD034, no-bare-urls)
43-43: Bare URL used
(MD034, no-bare-urls)
44-44: Bare URL used
(MD034, no-bare-urls)
44-44: Bare URL used
(MD034, no-bare-urls)
45-45: Bare URL used
(MD034, no-bare-urls)
45-45: Bare URL used
(MD034, no-bare-urls)
46-46: Bare URL used
(MD034, no-bare-urls)
46-46: Bare URL used
(MD034, no-bare-urls)
47-47: Bare URL used
(MD034, no-bare-urls)
47-47: Bare URL used
(MD034, no-bare-urls)
48-48: Bare URL used
(MD034, no-bare-urls)
48-48: Bare URL used
(MD034, no-bare-urls)
104-104: Bare URL used
(MD034, no-bare-urls)
104-104: Bare URL used
(MD034, no-bare-urls)
🔇 Additional comments (27)
docusaurus.config.js (1)
22-25: LGTM! Redirect properly configured.The redirect from
/docs/hyperindex-basicsto/docs/HyperIndex/getting-startedfollows the established pattern and will prevent 404 errors for users accessing the old URL.docs/HyperSync/hypersync-query.md (1)
446-446: Link update creates a self-reference.The API reference link now points to the current page (
/docs/HyperSync/hypersync-query). If this page is indeed the complete API reference, this is acceptable, though the text "refer to the [HyperSync API Reference]" linking to the current page may be confusing to users.Consider clarifying the text if this is a self-reference:
-For a complete list of all available fields, refer to the [HyperSync API Reference](https://docs.envio.dev/docs/HyperSync/hypersync-query). +For a complete list of all available fields, see the field schemas above.Or verify if this should link to a different, more comprehensive API reference page.
blog/2024-05-24-case-study-peppy-finance.md (1)
56-56: LGTM! HyperSync link correctly updated.The link has been properly updated to reflect the new HyperSync documentation structure at
/docs/HyperSync/overview.blog/2024-03-01-envio-community-update-7.md (1)
29-29: LGTM! HyperSync link correctly updated.The link has been properly updated to reflect the new HyperSync documentation structure.
blog/2024-03-27-envio-community-update-8.md (1)
19-19: LGTM! HyperSync link correctly updated.The link has been properly updated to the new documentation path.
blog/2024-02-20-envio-data-indexing-on-lukso.md (1)
36-36: LGTM! HyperSync link correctly updated.The link update is consistent with the documentation restructuring.
docs/HyperIndex/Examples/example-ens.md (1)
22-22: Nice addition!Adding the step to stop the indexer provides helpful cleanup instructions for users.
blog/2024-05-08-envio-community-update-9.md (1)
32-32: Good link path reorganization.Moving HyperSync documentation to a dedicated
HyperSync/overviewpath (rather than nested under HyperIndex) is a clear improvement for information architecture. Link text is descriptive.Verify the destination URL
https://docs.envio.dev/docs/HyperSync/overviewexists in the documentation structure.blog/2024-05-30-envio-community-update-may-2024.md (1)
27-27: Clean documentation path reorganization.The link correctly points to the new HyperSync overview page. Link text is appropriately descriptive.
Confirm the destination URL
https://docs.envio.dev/docs/HyperSync/overviewis valid.blog/2024-04-22-envio-hypersync-powers-data-access-on-fuel-network.md (2)
19-19: Clean HyperSync documentation reference.Link correctly reorganizes HyperSync documentation to standalone section. Inline link text is descriptive.
Verify the destination URL
https://docs.envio.dev/docs/HyperSync/overviewexists.
136-136: Consistent documentation link update.Link in the "Relevant Links" section correctly points to HyperSync overview. Maintains consistency with line 19 reorganization.
blog/2024-08-13-case-study-sablier.md (1)
128-128: Good HyperSync documentation reference.Link correctly reorganizes HyperSync documentation. Link text is descriptive (bold for emphasis is appropriate in this context).
Confirm the destination URL
https://docs.envio.dev/docs/HyperSync/overviewis valid.blog/2024-07-18-data-indexing-on-fuel.md (1)
41-41: Link updates align with documentation restructuring.The removal of
/v2/path segments from HyperIndex links reflects a consistent documentation reorganization pattern across the PR. These changes appear correct.Also applies to: 49-49
blog/2024-03-27-envio-data-indexing-on-harmony.md (1)
27-27: Documentation links properly restructured for HyperSync and HyperRPC.Links updated to reflect the new documentation organization. All changes are consistent with the PR's link migration pattern.
Also applies to: 29-29, 35-35
blog/2024-07-17-case-study-gblast.md (2)
72-72: HyperSync documentation link properly updated.Link restructured to the new documentation path
/docs/HyperSync/overview. Consistent with other changes in the PR.
83-83: Verify HyperSync documentation link path.Line 83 references
/docs/hypersyncwhile other links in this file and throughout the PR use/docs/HyperSync/overview. Confirm this link is intentional or should be updated for consistency.blog/2023-10-26-envio-community-update-3.md (1)
21-21: Subgraph migration link properly relocated.Updated to
/docs/HyperIndex/migration-guide, aligning with the documentation reorganization pattern throughout the PR.docs/HyperSync/hypersync-supported-networks.md (1)
34-34: New network entries properly formatted and added.Seven new networks (Ab, Arc Testnet, Berachain, Blast, Blast Sepolia, Boba, Sentient) are consistently added with correct network IDs and endpoint URLs.
Also applies to: 39-39, 45-48, 104-104
blog/2024-02-12-envio-azuro-developer-grant-multi-chain-open-source-indexer.md (1)
84-84: Documentation link properly updated to getting-started.Changed from
/docs/installationto/docs/HyperIndex/getting-started, reflecting the documentation reorganization.blog/2024-01-31-envio-community-update-6.md (1)
17-17: HyperSync documentation link properly restructured.Updated to
/docs/HyperSync/overview, aligning with the documentation organization changes throughout the PR.docs/HyperRPC/hyperrpc-supported-networks.md (1)
26-26: New network entries properly formatted and consistent across HyperSync/HyperRPC.Seven networks added with matching IDs and consistent endpoint formatting between HyperSync and HyperRPC documentation. Excellent consistency in the updates.
Also applies to: 31-31, 37-40, 96-96
docs/HyperIndex/supported-networks/sentient.md (2)
1-63: ****The page structure, metadata, YAML configuration example, and content quality follow the established documentation pattern. Formatting is consistent with other network support pages (Ab and Arc Testnet).
26-32: All internal documentation links are valid and exist in the codebase.Verification confirms that all four links referenced in the file (
/docs/HyperIndex/overview,/docs/HyperSync/overview,/docs/HyperRPC/overview-hyperrpc,/docs/HyperIndex/contract-import) point to existing documentation files. No 404 errors will occur for these links.docs/HyperIndex/supported-networks/ab.md (1)
1-63: ****Page follows the established documentation template consistently with Sentient and Arc Testnet pages. Metadata, YAML configuration, and internal links are well-structured. Note: Endpoint verification and internal link validation are already captured in the Sentient file review above and apply here as well.
docs/HyperIndex/supported-networks/arc-testnet.md (3)
1-63: ****The restructuring aligns Arc Testnet documentation with the new Envio-centric template established for Ab and Sentient networks. The migration from RPC-focused to a unified HyperIndex/HyperSync/HyperRPC approach is consistent with the PR's modernization objective. Pending verification of chain ID consistency and endpoint functionality (captured in preceding comments).
38-53: YAML configuration is correct and backward compatible—no action required.The removal of
rpc_configis intentional and correct. Arc Testnet supports HyperSync (Tier: STONE), and per the documentation, the absence ofrpc_configmeans the indexer will use HyperSync instead of RPC—which is the recommended approach for better performance. The identifierid: 5042002correctly matches the official Chain ID. Existing Arc Testnet indexers will not break as the configuration maintains proper syntax and required fields.
10-32: I need to verify that the Arc Testnet endpoints are functional and check for any legacy configuration references that might have been missed.Based on the web search, Arc Testnet is actively live and supported. Now I need to verify there are no legacy configuration references in the codebase that might have been missed:
No issues found—Arc Testnet configuration is consistent and functional.
Chain ID 5042002 is correctly used across all documentation, and Arc's public testnet launched in October 2025 with active infrastructure support. The testnet is supported by over 100 institutions and uses USDC as native gas. All endpoint references (HyperSync and HyperRPC URLs) are consistent across HyperIndex, HyperSync, and HyperRPC documentation. No legacy rpc_config patterns or backward compatibility issues exist.
3 participants
Updated a bunch of broken links.
Summary by CodeRabbit