Update LLM complete docs metadata#821
Conversation
Made-with: Cursor
Made-with: Cursor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Warning Rate limit exceeded
⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
📝 WalkthroughWalkthroughThis PR enhances documentation for HyperIndex, HyperRPC, and HyperSync by adding front-matter metadata (description, keywords, robots directives), introducing Key Facts info blocks summarizing capabilities and prerequisites, and appending FAQ sections addressing common questions. Additionally, docusaurus.config.js is reorganized to consolidate LLM documentation sections, and robots.txt receives a minor newline adjustment. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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: 8
🤖 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`:
- Line 10359: Update the Telegram bullet text that currently reads
"**Telegram**: [Envio Telegram](https://t.me/+kAIGElzPjApiMjI0) - the offcial
Envio Telegram to get support from the team and community" by correcting the
typo "offcial" to "official" so it reads "... the official Envio Telegram ...";
locate the sentence containing the "Telegram: [Envio
Telegram](https://t.me/+kAIGElzPjApiMjI0)" link or the word "offcial" in the
docs/HyperIndex-LLM/hyperindex-complete.mdx file and make the single-word
correction.
- Around line 10304-10306: Update the FAQ answer under the "What blockchains
does HyperIndex support?" heading to include Fuel alongside EVM-compatible
chains so it matches the Key Facts and Fuel section; edit the sentence that
currently reads "HyperIndex supports all EVM-compatible chains" to something
like "HyperIndex supports all EVM-compatible chains and Fuel" and retain the
rest about HyperSync and RPC indexing to preserve the note about over 70
networks and chains without HyperSync.
- Around line 6-8: The front-matter key "robots" is unsupported and will be
ignored; replace it with a supported approach by removing the "robots" entry and
either add unlisted: true to the front-matter (to prevent indexing) or keep the
page front-matter and add an inline head meta tag by inserting <meta
name="robots" content="noindex, nofollow"> into the page's <head> section;
update the "robots" key references in hyperindex-complete.mdx accordingly and
ensure only "unlisted" or the head meta is used so the page is not indexed.
In `@docs/HyperRPC-LLM/hyperrpc-complete.mdx`:
- Line 27: Update the outdated future-tense phrasing "starts/will be ...
starting June 2025" to past/present tense in the document: replace the table
cell text containing "API token | Recommended — rate limiting starts June 2025"
and the other occurrence of "starting June 2025" with wording like "has been
rate limited since June 2025" (or similar present/past-tense phrasing) so both
instances use consistent, up-to-date tense.
- Line 336: Fix the typo in the Telegram support channel description by changing
the word "offcial" to "official" within the string "**Telegram**: [Envio
Telegram](https://t.me/+kAIGElzPjApiMjI0) - the offcial Envio Telegram to get
support from the team and community" so the sentence reads "...the official
Envio Telegram to get support from the team and community".
- Around line 11-14: Remove the duplicated heading/introduction block titled
"HyperRPC Complete Documentation" that appears in the earlier lines (the same
content duplicated at Lines 11–14 and 36–39); keep a single instance of the
heading/intro (the later one at Lines 36–39) and delete the earlier duplicate so
the document contains only one "HyperRPC Complete Documentation" heading and its
introductory paragraph.
- Line 8: The MDX frontmatter field robots is present but not being emitted as a
meta tag; update the Docusaurus configuration or add a metadata processor:
either add robots into themeConfig.metadata in both docusaurus.config.js and
docusaurus.config.llm.js so the value from frontmatter is included in generated
metadata, or implement a DocItem/Metadata React component that reads
frontMatter.robots (via the useFrontMatter hook) and injects <meta name="robots"
content={frontMatter.robots} /> into the page head (e.g., using the
Head/MetaTags provider), ensuring pages with robots: "noindex, nofollow" produce
the correct meta tag.
In `@docs/HyperSync-LLM/hypersync-complete.mdx`:
- Around line 2824-2826: Fix the typo in the Telegram list item by changing
"offcial" to "official" in the markdown text (the line that begins
"**Telegram**: [Envio Telegram]... - the offcial Envio Telegram to get support
from the team and community"); update that string to read "the official Envio
Telegram to get support from the team and community".
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: f232b9df-c64a-411e-8491-cbd87af32350
📒 Files selected for processing (5)
docs/HyperIndex-LLM/hyperindex-complete.mdxdocs/HyperRPC-LLM/hyperrpc-complete.mdxdocs/HyperSync-LLM/hypersync-complete.mdxdocusaurus.config.jsstatic/robots.txt
| description: Complete reference documentation for HyperIndex — Envio's blazing-fast multichain blockchain indexer. Covers setup, configuration, event handlers, multichain indexing, GraphQL APIs, and migration from TheGraph, Ponder, SQD, SubQuery, and more. | ||
| keywords: [HyperIndex, blockchain indexer, multichain indexing, HyperSync, Envio, GraphQL, TheGraph alternative, EVM indexer, smart contract events, Ponder alternative, SQD alternative, SubQuery alternative] | ||
| robots: noindex, nofollow |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
# Find Docusaurus config files and front-matter related configurations
find . -maxdepth 3 -type f \( -name "docusaurus.config.js" -o -name "docusaurus.config.ts" -o -name "docusaurus.json" \) 2>/dev/null | head -20Repository: enviodev/docs
Length of output: 79
🏁 Script executed:
# Check the structure and content of the target file
if [ -f "docs/HyperIndex-LLM/hyperindex-complete.mdx" ]; then
echo "=== File exists. First 50 lines: ==="
head -50 "docs/HyperIndex-LLM/hyperindex-complete.mdx" | cat -n
else
echo "File not found at specified location"
find . -type f -name "hyperindex-complete.mdx" 2>/dev/null
fiRepository: enviodev/docs
Length of output: 2852
🏁 Script executed:
# Search for any custom front-matter or meta-related configurations in the repo
rg "robots|front.?matter|unlisted" --type js --type ts --type json -A 3 | head -100Repository: enviodev/docs
Length of output: 896
🌐 Web query:
Docusaurus front-matter robots key support and noindex approaches
💡 Result:
Does Docusaurus support a front-matter robots: key?
Not as a documented/built-in front-matter field (unlike title, description, keywords, etc.). For “noindex”, Docusaurus’ docs recommend adding a robots meta tag as page metadata instead. [1]
Recommended “noindex” approaches in Docusaurus
1) Site-wide noindex (everything)
Set noIndex: true in docusaurus.config.*. This injects <meta name="robots" content="noindex, nofollow"> on every page. [2]
2) Per-page noindex (single doc/blog/page)
Add a robots meta tag in the page’s <head> (MDX/Markdown supports inline <head>...</head> for page metadata), e.g.:
<meta name="robots" content="noindex"> (or noindex, nofollow). [1]
For React/JSX pages, use Docusaurus’ <Head> component to add the same meta tag. [1]
3) HTTP header noindex (platform/server-level)
If your hosting supports it, you can send an X-Robots-Tag: noindex response header. (Docusaurus notes some hosts may allow this; GitHub Pages does not.) [1]
Notes / gotchas
robots.txtdoes not prevent pages from being indexed (it mainly controls crawling). [1]- Docusaurus’ sitemap plugin will automatically exclude pages that have a
noindexrobots meta directive. [1]
Sources: Docusaurus SEO guide (per-page meta, robots.txt caveat, noindex options, sitemap behavior) [1]; Docusaurus config noIndex option [2].
robots front-matter key is unsupported—will not achieve noindex goal.
Docusaurus does not recognize robots as a built-in docs front-matter field. Line 8 will be ignored, leaving the page indexed contrary to the PR objective. Use an inline <meta name="robots"> tag in the page's <head> section instead, or apply unlisted: true to the front-matter.
Recommended fix
---
id: hyperindex-complete
title: HyperIndex Complete Documentation
sidebar_label: HyperIndex Complete Documentation
slug: /hyperindex-complete
description: Complete reference documentation for HyperIndex — Envio's blazing-fast multichain blockchain indexer. Covers setup, configuration, event handlers, multichain indexing, GraphQL APIs, and migration from TheGraph, Ponder, SQD, SubQuery, and more.
keywords: [HyperIndex, blockchain indexer, multichain indexing, HyperSync, Envio, GraphQL, TheGraph alternative, EVM indexer, smart contract events, Ponder alternative, SQD alternative, SubQuery alternative]
-robots: noindex, nofollow
---
+<head>
+ <meta name="robots" content="noindex, nofollow" />
+</head>
+
# HyperIndex Complete Documentation📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| description: Complete reference documentation for HyperIndex — Envio's blazing-fast multichain blockchain indexer. Covers setup, configuration, event handlers, multichain indexing, GraphQL APIs, and migration from TheGraph, Ponder, SQD, SubQuery, and more. | |
| keywords: [HyperIndex, blockchain indexer, multichain indexing, HyperSync, Envio, GraphQL, TheGraph alternative, EVM indexer, smart contract events, Ponder alternative, SQD alternative, SubQuery alternative] | |
| robots: noindex, nofollow | |
| --- | |
| id: hyperindex-complete | |
| title: HyperIndex Complete Documentation | |
| sidebar_label: HyperIndex Complete Documentation | |
| slug: /hyperindex-complete | |
| description: Complete reference documentation for HyperIndex — Envio's blazing-fast multichain blockchain indexer. Covers setup, configuration, event handlers, multichain indexing, GraphQL APIs, and migration from TheGraph, Ponder, SQD, SubQuery, and more. | |
| keywords: [HyperIndex, blockchain indexer, multichain indexing, HyperSync, Envio, GraphQL, TheGraph alternative, EVM indexer, smart contract events, Ponder alternative, SQD alternative, SubQuery alternative] | |
| --- | |
| <head> | |
| <meta name="robots" content="noindex, nofollow" /> | |
| </head> | |
| # HyperIndex Complete Documentation |
🤖 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 6 - 8, The
front-matter key "robots" is unsupported and will be ignored; replace it with a
supported approach by removing the "robots" entry and either add unlisted: true
to the front-matter (to prevent indexing) or keep the page front-matter and add
an inline head meta tag by inserting <meta name="robots" content="noindex,
nofollow"> into the page's <head> section; update the "robots" key references in
hyperindex-complete.mdx accordingly and ensure only "unlisted" or the head meta
is used so the page is not indexed.
| slug: /hyperrpc-complete | ||
| description: Complete reference documentation for HyperRPC — Envio's ultra-fast read-only JSON-RPC endpoint. A drop-in replacement for traditional RPC nodes, powered by HyperSync, supporting 85+ EVM-compatible networks with up to 5x faster performance for data-intensive blockchain operations. | ||
| keywords: [HyperRPC, JSON-RPC, fast RPC, blockchain RPC, Envio, EVM RPC, eth_getLogs, read-only RPC, HyperSync, blockchain data, RPC alternative, drop-in RPC] | ||
| robots: noindex, nofollow |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# 1) Confirm where `robots:` frontmatter is used in docs
rg -n --glob '**/*.md' --glob '**/*.mdx' '^\s*robots\s*:'
# 2) Confirm whether site code/config consumes that field
rg -n -C3 --glob '**/*.{js,jsx,ts,tsx}' \
'frontMatter\.robots|meta[^\\n]*name=["'"'"']robots["'"'"']|noindex|nofollow|headTags|Seo|DocItem/Metadata'
# 3) Inspect Docusaurus config for robots/meta injection points
rg -n -C3 --glob 'docusaurus.config.*' 'robots|noindex|nofollow|headTags|scripts|themeConfig'Repository: enviodev/docs
Length of output: 266
🏁 Script executed:
# Find and read docusaurus config file
find . -name 'docusaurus.config.*' -type fRepository: enviodev/docs
Length of output: 106
🏁 Script executed:
# Check Docusaurus version and basic config
cat package.json | head -50Repository: enviodev/docs
Length of output: 2154
🏁 Script executed:
# Search for meta tag generation patterns more broadly
rg -n 'meta\s*name' --glob '**/*.{js,jsx,ts,tsx,mdx}' -A2 -B2 | head -100Repository: enviodev/docs
Length of output: 563
🏁 Script executed:
# Look for helmet, react-helmet, or similar meta tag libraries
rg -n 'helmet|Helmet|meta.*robots|setMeta|addMeta' --glob '**/*.{js,jsx,ts,tsx}' | head -50Repository: enviodev/docs
Length of output: 39
🏁 Script executed:
# Read the docusaurus.config.js to check meta/robots configuration
cat docusaurus.config.jsRepository: enviodev/docs
Length of output: 28521
🏁 Script executed:
# Read the LLM config file
cat docusaurus.config.llm.jsRepository: enviodev/docs
Length of output: 4791
🏁 Script executed:
# Look for theme customization or DocItem metadata overrides
find . -path '*/theme/*' -name '*.js' -o -name '*.jsx' -o -name '*.tsx' | head -20Repository: enviodev/docs
Length of output: 178
🏁 Script executed:
# Check if there's a DocItem/Metadata theme override
find . -path '*/theme/DocItem*' -type fRepository: enviodev/docs
Length of output: 137
🏁 Script executed:
# Search for any frontmatter processing or meta tag injection code
rg -n 'frontMatter|metadata|meta\s*name' src/theme --glob '**/*.{js,jsx,tsx}' -B2 -A2Repository: enviodev/docs
Length of output: 958
🏁 Script executed:
# Check what the actual MDX file contains to understand the full context
head -20 docs/HyperRPC-LLM/hyperrpc-complete.mdxRepository: enviodev/docs
Length of output: 867
Wire the robots frontmatter field into Docusaurus metadata generation.
The robots: noindex, nofollow frontmatter exists in the MDX file but is not configured in Docusaurus to be rendered as a page meta tag. Docusaurus 3.x does not automatically convert custom frontmatter fields to meta tags. Add robots to themeConfig.metadata in docusaurus.config.js and docusaurus.config.llm.js, or create a custom DocItem/Metadata component to process the field from frontmatter into the page head. Without this, the noindex objective will not be met.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/HyperRPC-LLM/hyperrpc-complete.mdx` at line 8, The MDX frontmatter field
robots is present but not being emitted as a meta tag; update the Docusaurus
configuration or add a metadata processor: either add robots into
themeConfig.metadata in both docusaurus.config.js and docusaurus.config.llm.js
so the value from frontmatter is included in generated metadata, or implement a
DocItem/Metadata React component that reads frontMatter.robots (via the
useFrontMatter hook) and injects <meta name="robots"
content={frontMatter.robots} /> into the page head (e.g., using the
Head/MetaTags provider), ensuring pages with robots: "noindex, nofollow" produce
the correct meta tag.
2 participants
Summary
robots: noindex, nofollowto keep them out of search indexing.Files changed
docs/HyperIndex-LLM/hyperindex-complete.mdxdocs/HyperSync-LLM/hypersync-complete.mdxdocs/HyperRPC-LLM/hyperrpc-complete.mdx