docs: refresh content metadata

[Jordy-Baby]

Summary

• align doc titles/descriptions with actual content
• remove duplicate h1 headings and add short intros where needed
• update site tagline/blog metadata for clearer messaging

Testing

• node -e "const fs = require('fs'); const matter = require('gray-matter'); const { execSync } = require('child_process'); const files = execSync('find docs -name '.md' -o -name '.mdx'', {encoding: 'utf8'}).trim().split('\n').filter(Boolean); files.forEach(f => matter(fs.readFileSync(f, 'utf8'))); console.log('all good');"

Summary by CodeRabbit

• Documentation

  • Updated documentation titles, descriptions, and metadata for improved clarity and navigation
  • Enhanced page descriptions across HyperIndex, HyperSync, and HyperRPC sections
  • Improved heading structure and formatting for better readability

• Chores

  • Updated website tagline and blog section descriptions
  • Removed Optimism network from supported networks tables
  • Reformatted network list for improved maintainability

_{✏️ 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	Preview	Comments	Updated (UTC)
envio-docs	Ready	Preview	Comment	Nov 28, 2025 3:17pm

[coderabbitai]

Walkthrough

Documentation and site configuration updates focused on rebranding references to Envio, normalizing heading structures across multiple pages, removing redundant H1 headers, updating front matter titles and descriptions, reformatting network data, and removing Optimism network entries from supported networks tables.

Changes

Cohort / File(s)	Summary
Front Matter & Heading Normalization docs/HyperIndex/Advanced/dynamic-contracts.md, docs/HyperIndex/Examples/example-liquidation-metrics.md, docs/HyperIndex/Tutorials/greeter-tutorial.md, docs/HyperIndex/Tutorials/tutorial-erc20-token-transfers.md, docs/HyperIndex/Tutorials/tutorial-indexing-fuel.md, docs/HyperIndex/Tutorials/tutorial-op-bridge-deposits.md, docs/HyperSync/quickstart.md	Removed top-level H1 headings and adjusted front matter titles for consistency.
Documentation Structure Updates docs/HyperIndex/Advanced/multichain-indexing.mdx, docs/HyperSync/HyperFuel/hyperfuel.md	Added section headers and enhanced page descriptions for improved content organization.
Metadata & Content Rebranding docs/HyperIndex/contract-import.md, docs/HyperIndex/getting-started.md, docs/HyperIndex/overview.md, docs/HyperIndex/privacy-policy.md, docs/HyperIndex/Hosted_Service/hosted-service.md, docs/HyperSync/overview.md	Updated front matter titles, descriptions, and removed redundant H1 headings; rebranded to Envio terminology.
Migration Guide Update docs/HyperIndex/migration-guide.md	Updated metadata and headings to reference migrating to Envio and improved description copy.
Network Documentation Updates docs/HyperRPC/hyperrpc-supported-networks.md, docs/HyperSync/hypersync-supported-networks.md	Updated descriptions and removed Optimism row from networks tables.
Site Configuration docusaurus.config.js	Updated site tagline, blog title, and added blog description.
Data Formatting supported-networks.json	Reformatted network list from single-line to multi-line representation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Mostly repetitive formatting and title updates following consistent patterns across multiple files
• Front matter changes are straightforward metadata adjustments
• Extra attention areas:
  • Verify Optimism removal from network tables in hyperrpc-supported-networks.md and hypersync-supported-networks.md is intentional
  • Confirm site configuration changes in docusaurus.config.js are accurate for branding purposes

Possibly related PRs

• Showcase Update: Added Safe Stats #721: Removes Optimism from supported-networks tables in both HyperRPC and HyperSync documentation
• migrate from alchemy guide & migration section addition #742: Updates migration-guide.md metadata and adds related sidebar entries
• Update supported chains #672: Reformats and modifies entries in supported-networks.json structure

Suggested reviewers

• moose-code
• DenhamPreen
• nikbhintade

---

🐰 Docs now shine with Envio's name so bright,
Headings trimmed, front matter set right,
Networks rearranged with care,
Config tweaked with style to spare,
Our rebranding hops into the light! ✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'docs: refresh content metadata' accurately summarizes the main changes, which involve updating documentation metadata (titles, descriptions, taglines) and removing duplicate headings across multiple files.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ 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 chore/docs-content-refresh

---

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.}

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

docs/HyperIndex/migration-guide.md (1)

3-11: Align title, description, and H1 phrasing for consistency

Right now this page mixes three framings (“Subgraph to HyperIndex”, “Migrate from TheGraph”, and “to Envio”). For readability and SEO, it would help to pick one primary framing and use it consistently across title, description, and H1.

For example, to lean into the new Envio-centric framing you could do:

---
 id: migration-guide
-title: Migrate from a Subgraph to HyperIndex
+title: How to Migrate from TheGraph to Envio
 sidebar_label: Migrate from TheGraph
 slug: /migration-guide
 description: Learn how to migrate your Subgraphs to Envio for faster indexing, multichain support, and a better developer experience.
---
 
-# How to Migrate from TheGraph to Envio
+# How to Migrate from TheGraph to Envio

(Body references to HyperIndex can stay as-is if the intent is “migrate to Envio’s HyperIndex”.)

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ae28af6 and 09353c3.

📒 Files selected for processing (20)

• docs/HyperIndex/Advanced/dynamic-contracts.md (1 hunks)
• docs/HyperIndex/Advanced/multichain-indexing.mdx (1 hunks)
• docs/HyperIndex/Examples/example-liquidation-metrics.md (0 hunks)
• docs/HyperIndex/Hosted_Service/hosted-service.md (1 hunks)
• docs/HyperIndex/Tutorials/greeter-tutorial.md (0 hunks)
• docs/HyperIndex/Tutorials/tutorial-erc20-token-transfers.md (0 hunks)
• docs/HyperIndex/Tutorials/tutorial-indexing-fuel.md (0 hunks)
• docs/HyperIndex/Tutorials/tutorial-op-bridge-deposits.md (0 hunks)
• docs/HyperIndex/contract-import.md (1 hunks)
• docs/HyperIndex/getting-started.md (1 hunks)
• docs/HyperIndex/migration-guide.md (1 hunks)
• docs/HyperIndex/overview.md (1 hunks)
• docs/HyperIndex/privacy-policy.md (1 hunks)
• docs/HyperRPC/hyperrpc-supported-networks.md (1 hunks)
• docs/HyperSync/HyperFuel/hyperfuel.md (1 hunks)
• docs/HyperSync/hypersync-supported-networks.md (1 hunks)
• docs/HyperSync/overview.md (1 hunks)
• docs/HyperSync/quickstart.md (0 hunks)
• docusaurus.config.js (2 hunks)
• supported-networks.json (1 hunks)

💤 Files with no reviewable changes (6)

• docs/HyperIndex/Tutorials/tutorial-op-bridge-deposits.md
• docs/HyperSync/quickstart.md
• docs/HyperIndex/Tutorials/greeter-tutorial.md
• docs/HyperIndex/Examples/example-liquidation-metrics.md
• docs/HyperIndex/Tutorials/tutorial-indexing-fuel.md
• docs/HyperIndex/Tutorials/tutorial-erc20-token-transfers.md

🧰 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
• supported-networks.json
• docs/HyperSync/hypersync-supported-networks.md

🔇 Additional comments (13)

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

6-6: Description improves documentation clarity.

The updated description accurately summarizes page content (coverage tiers, reliability notes, chain onboarding criteria) and should improve discoverability and user understanding.

supported-networks.json (1)

5-5: JSON reformatting improves maintainability.

Wrapping the long inline array into multi-line format enhances readability and makes future diffs clearer without altering any network data or structure.

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

6-6: Description clearly communicates HyperRPC-specific information.

The updated description (endpoints, network IDs, trace support, regular updates) accurately reflects the page content and improves SEO discoverability.

docs/HyperIndex/Advanced/dynamic-contracts.md (1)

3-4: Title and sidebar label refined for clarity.

Updated to "Loading Dynamic Contracts / Factories" to better reflect that the page covers both factory patterns and dynamic contract registration, improving navigation and content alignment.

docs/HyperIndex/overview.md (1)

3-3: Page title strengthens branding and clarity.

Updated from "Overview" to "HyperIndex: Fast Multichain Indexer" to communicate the product's key value proposition upfront, and the duplicate H1 heading was removed from the body as part of consistent heading normalization.

docs/HyperIndex/getting-started.md (2)

3-3: Title update clarifies Envio context.

Changing from "Getting Started" to "Getting Started with Envio" improves specificity and helps users understand the scope immediately.

---

9-10: Introductory sentence provides content preview.

Adding a brief intro describing the content flow (initialization to local testing to deployment) helps users understand what to expect, aligning with the PR objective to add short intros where needed.

docs/HyperIndex/contract-import.md (1)

3-3: Title provides better product context.

Updating from "Quickstart" to "HyperIndex Quickstart" clarifies this is specific to HyperIndex initialization, improving clarity while keeping the sidebar label concise.

docs/HyperIndex/privacy-policy.md (1)

1-7: Front matter description is clear and aligned

The new description is accurate, concise, and matches the page content and purpose; looks good as SEO/meta copy.

docs/HyperIndex/Hosted_Service/hosted-service.md (1)

2-7: Title update improves clarity and avoids duplicate H1

Using Envio Hosted Service as the title matches the product name and, with the body H1 removed, avoids duplicate top-level headings in Docusaurus.

docs/HyperSync/overview.md (1)

2-7: Title simplification is appropriate

Using HyperSync as the page title is concise and works well alongside the more descriptive H1 (HyperSync: Ultra-Fast & Flexible Data API) in the content.

docs/HyperSync/HyperFuel/hyperfuel.md (1)

2-7: Expanded description improves discoverability

The updated description clearly explains what HyperFuel is, how it relates to HyperSync, and the types of data/queries it supports, which is great for both users and search.

docusaurus.config.js (1)

234-257: Updated tagline and blog metadata match current docs scope

The new tagline accurately reflects the three product areas and what users can do, and the Envio Blog title/description provide clearer branding and expectations for the blog section. Config structure remains valid.

[coderabbitai]

⚠️ Potential issue | 🟠 Major

Remove duplicate heading: consolidate H2 and H1 with same text.

Lines 9–10 introduce a new H2 heading ("## Understanding Multichain Indexing"), and line 14 contains the existing H1 with the same text ("# Understanding Multichain Indexing"). This creates a duplicate heading structure that conflicts with the PR objective to remove duplicate H1 headings.

Remove the H1 at line 14 to consolidate under the H2 introduced at line 9:

 import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";
 
-# Understanding Multichain Indexing

This will also improve the document structure by placing imports and content more logically.

Also applies to: 14-14

🤖 Prompt for AI Agents

In docs/HyperIndex/Advanced/multichain-indexing.mdx around lines 9–14, a
duplicate heading exists: an H2 "## Understanding Multichain Indexing" is added
at lines 9–10 while an identical H1 "# Understanding Multichain Indexing"
remains at line 14; remove the H1 at line 14 so the document uses the single H2
introduced at line 9, ensuring imports and subsequent content remain correctly
positioned under that H2.

[nikbhintade]

looks good