chore: added descriptions to all pages#720
Conversation
These will be used in lllms.txt & social preview of the link
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughThis pull request adds Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~20 minutes The changes are predominantly homogeneous front-matter additions across 60+ documentation files with minimal variance. While the file count is large, the repetitive nature of the edits and documentation-only scope significantly reduce review complexity. Two files with content modifications (network removal and configuration expansion) add minimal additional effort. Possibly related PRs
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
🧹 Nitpick comments (3)
docs/HyperSync/hypersync-supported-networks.md (1)
6-6: Minor formatting: add terminal period to description.The description accurately reflects the page's purpose, but should end with a period for consistency with other files. Most descriptions in the PR end with a period.
-description: Discover all networks currently supported by HyperSync +description: Discover all networks currently supported by HyperSync.docs/HyperIndex/privacy-policy.md (1)
6-6: LGTM. Minor grammar refinement: consider "Learn about Envio's privacy policy" for smoother phrasing (optional).docs/HyperIndex/Advanced/rpc-sync.md (1)
1-7: Consider adding a period to the description for consistency.Line 6 description reads:
"Learn how to index any EVM blockchain using RPC and optimize performance with HyperIndex"— most other descriptions in the PR end with a period; this one is missing it. Minor formatting consistency improvement.- description: Learn how to index any EVM blockchain using RPC and optimize performance with HyperIndex + description: Learn how to index any EVM blockchain using RPC and optimize performance with HyperIndex.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (74)
docs/HyperIndex/Advanced/config-schema-reference.md(1 hunks)docs/HyperIndex/Advanced/dynamic-contracts.md(1 hunks)docs/HyperIndex/Advanced/effect-api.md(1 hunks)docs/HyperIndex/Advanced/generated-files.md(1 hunks)docs/HyperIndex/Advanced/hypersync.md(1 hunks)docs/HyperIndex/Advanced/loaders.md(1 hunks)docs/HyperIndex/Advanced/metadata-query.md(1 hunks)docs/HyperIndex/Advanced/multichain-indexing.mdx(1 hunks)docs/HyperIndex/Advanced/performance/benchmarking.md(1 hunks)docs/HyperIndex/Advanced/performance/database-performance-optimization.md(1 hunks)docs/HyperIndex/Advanced/performance/historical-sync.md(1 hunks)docs/HyperIndex/Advanced/performance/index.md(1 hunks)docs/HyperIndex/Advanced/performance/latency-at-head.md(1 hunks)docs/HyperIndex/Advanced/persisted_files.md(1 hunks)docs/HyperIndex/Advanced/preload-optimization.md(1 hunks)docs/HyperIndex/Advanced/reorgs-support.md(1 hunks)docs/HyperIndex/Advanced/rpc-sync.md(1 hunks)docs/HyperIndex/Advanced/terminology.md(1 hunks)docs/HyperIndex/Advanced/wildcard-indexing.mdx(1 hunks)docs/HyperIndex/Examples/example-aerodrome-velodrome.md(1 hunks)docs/HyperIndex/Examples/example-ens.md(1 hunks)docs/HyperIndex/Examples/example-example-cross-chain-messaging.md(1 hunks)docs/HyperIndex/Examples/example-liquidation-metrics.md(1 hunks)docs/HyperIndex/Examples/example-sablier.md(1 hunks)docs/HyperIndex/Examples/example-uniswap-v4.md(1 hunks)docs/HyperIndex/Guides/block-handlers.md(1 hunks)docs/HyperIndex/Guides/cli-commands.md(1 hunks)docs/HyperIndex/Guides/configuration-file.mdx(1 hunks)docs/HyperIndex/Guides/contract-state.md(1 hunks)docs/HyperIndex/Guides/environment-variables.md(1 hunks)docs/HyperIndex/Guides/event-handlers.mdx(1 hunks)docs/HyperIndex/Guides/ipfs.md(1 hunks)docs/HyperIndex/Guides/navigating-hasura.md(1 hunks)docs/HyperIndex/Guides/running-locally.md(1 hunks)docs/HyperIndex/Guides/schema-file.md(1 hunks)docs/HyperIndex/Guides/testing.mdx(1 hunks)docs/HyperIndex/Hosted_Service/hosted-service-billing.mdx(1 hunks)docs/HyperIndex/Hosted_Service/hosted-service-deployment.md(1 hunks)docs/HyperIndex/Hosted_Service/hosted-service.md(1 hunks)docs/HyperIndex/Hosted_Service/self-hosting.md(1 hunks)docs/HyperIndex/Troubleshoot/common-issues.md(1 hunks)docs/HyperIndex/Troubleshoot/error-codes.md(1 hunks)docs/HyperIndex/Troubleshoot/logging.mdx(1 hunks)docs/HyperIndex/Troubleshoot/reserved-words.md(1 hunks)docs/HyperIndex/Tutorials/greeter-tutorial.md(1 hunks)docs/HyperIndex/Tutorials/price-data.md(1 hunks)docs/HyperIndex/Tutorials/tutorial-erc20-token-transfers.md(1 hunks)docs/HyperIndex/Tutorials/tutorial-indexing-fuel.md(1 hunks)docs/HyperIndex/Tutorials/tutorial-op-bridge-deposits.md(1 hunks)docs/HyperIndex/Tutorials/tutorial-scaffold-eth-2.md(1 hunks)docs/HyperIndex/benchmarks.md(1 hunks)docs/HyperIndex/contract-import.md(1 hunks)docs/HyperIndex/fuel/fuel.md(1 hunks)docs/HyperIndex/getting-started.md(1 hunks)docs/HyperIndex/licensing.md(1 hunks)docs/HyperIndex/migration-guide-v1-v2.md(1 hunks)docs/HyperIndex/migration-guide.md(1 hunks)docs/HyperIndex/overview.md(1 hunks)docs/HyperIndex/privacy-policy.md(1 hunks)docs/HyperIndex/terms-of-service.md(1 hunks)docs/HyperRPC/hyperrpc-supported-networks.md(1 hunks)docs/HyperRPC/overview-hyperrpc.md(1 hunks)docs/HyperSync/HyperFuel/hyperfuel-query.md(1 hunks)docs/HyperSync/HyperFuel/hyperfuel.md(1 hunks)docs/HyperSync/api-tokens.mdx(1 hunks)docs/HyperSync/hypersync-clients.md(1 hunks)docs/HyperSync/hypersync-curl-examples.md(1 hunks)docs/HyperSync/hypersync-presets.md(1 hunks)docs/HyperSync/hypersync-query.md(1 hunks)docs/HyperSync/hypersync-supported-networks.md(1 hunks)docs/HyperSync/hypersync-usage.md(1 hunks)docs/HyperSync/overview.md(1 hunks)docs/HyperSync/quickstart.md(1 hunks)docs/HyperSync/tutorial-address-transactions.md(1 hunks)
🔇 Additional comments (73)
docs/HyperIndex/Advanced/dynamic-contracts.md (1)
6-6: LGTM. The description accurately summarizes the page content and is well-written for LLM crawlers.docs/HyperIndex/Tutorials/tutorial-erc20-token-transfers.md (1)
6-6: LGTM. The description is specific, accurate, and well-suited for LLM indexing.docs/HyperIndex/Examples/example-ens.md (1)
6-6: LGTM. Simple and accurate description appropriate for an example page.docs/HyperIndex/Advanced/preload-optimization.md (1)
6-6: LGTM. Well-crafted description that accurately captures the page's core concepts.docs/HyperIndex/migration-guide.md (1)
6-6: LGTM. Accurate, specific, and well-positioned for search discovery.docs/HyperIndex/Guides/testing.mdx (1)
6-6: LGTM. Clear, specific description that accurately represents the testing guide content.docs/HyperIndex/Guides/event-handlers.mdx (1)
6-6: LGTM. Concise and accurate description of the event handlers guide.docs/HyperIndex/terms-of-service.md (1)
6-6: Metadata addition is clear and appropriate.The description succinctly conveys the page's purpose for both LLM crawlers and social previews.
docs/HyperIndex/migration-guide-v1-v2.md (1)
6-6: Well-crafted description that accurately reflects guide content.The description highlights the key migration topics (async handlers, loaders, configs) covered in the guide, making it effective for metadata consumption.
docs/HyperSync/hypersync-presets.md (1)
6-6: Descriptive and relevant for the preset utilities page.The description appropriately conveys what preset queries accomplish and their efficiency benefit, making it suitable for both LLM indexing and previews.
docs/HyperIndex/Examples/example-example-cross-chain-messaging.md (1)
6-6: Concise and accurate description for the cross-chain messaging example.Effectively summarizes the page's focus on tracking cross-chain events while maintaining brevity suitable for metadata.
docs/HyperIndex/Tutorials/tutorial-op-bridge-deposits.md (1)
6-6: Accurate tutorial description that reflects the quick-start promise.The description effectively conveys both the learning outcome (indexing OP Bridge) and the expedited nature of the tutorial.
docs/HyperIndex/Advanced/loaders.md (1)
6-6: Appropriate description for the deprecated loaders feature.The description focuses on the technical purpose of loaders (performance improvement) rather than their deprecated status, which is suitable for metadata while the full deprecation context remains in page content.
docs/HyperSync/api-tokens.mdx (1)
6-6: Clear description for the API tokens documentation.Effectively conveys the practical scope (generation and usage) and security context of the page.
docs/HyperSync/hypersync-supported-networks.md (1)
32-119: No action required—Berachain Bartio removal is consistent across documentation.Verification confirms that Berachain Bartio has been consistently removed from both
docs/HyperSync/hypersync-supported-networks.mdanddocs/HyperRPC/hyperrpc-supported-networks.md. Both files now contain only the mainnet Berachain entry (network ID 80094), with no testnet variant present.docs/HyperIndex/Advanced/multichain-indexing.mdx (1)
6-6: LGTM. Clear, descriptive metadata addition suitable for LLM crawlers and social previews.docs/HyperIndex/Guides/running-locally.md (1)
6-6: LGTM. Well-crafted description that includes key technologies and is suitable for social previews.docs/HyperIndex/Guides/schema-file.md (1)
6-6: LGTM. Accurate, concise description covering the page's main topics.docs/HyperIndex/Guides/cli-commands.md (1)
6-6: LGTM. Clear description that captures the scope of CLI functionality across project lifecycle stages.docs/HyperIndex/Advanced/reorgs-support.md (1)
6-6: LGTM. Clear description that conveys both the technical problem and the outcome.docs/HyperIndex/Guides/environment-variables.md (1)
6-6: LGTM. Clear and descriptive metadata suitable for environmental configuration context.docs/HyperIndex/Advanced/generated-files.md (1)
6-6: LGTM. Well-targeted description addressing the three primary aspects covered in the generated files documentation.docs/HyperIndex/benchmarks.md (1)
6-6: Description metadata looks good.The description clearly conveys the page's purpose and includes a compelling value proposition. It's appropriately concise for both LLM crawlers and social media previews.
docs/HyperIndex/Advanced/effect-api.md (1)
6-6: Description is appropriately technical and concise.The description targets developers effectively with relevant terminology while remaining accessible. It accurately describes the page content.
docs/HyperIndex/getting-started.md (1)
6-6: Description effectively summarizes key topics.The description covers the main content areas (setup, templates, deployment) while remaining concise. Well-suited for its intended purpose.
docs/HyperIndex/Advanced/wildcard-indexing.mdx (1)
6-6: Description captures both key features.The description appropriately mentions both wildcard indexing and topic filtering, giving readers a complete understanding of the page scope.
docs/HyperSync/quickstart.md (1)
6-6: Description emphasizes speed while describing functionality.The use of "quickly" reinforces HyperSync's performance messaging. The description concisely conveys both the purpose (getting started) and capabilities (stream/filter).
docs/HyperSync/overview.md (1)
6-6: Description includes concrete product differentiators.The description effectively communicates HyperSync's key advantages (ultra-fast, flexible) and scale (70+ networks), which provides both clarity and SEO value.
docs/HyperIndex/Hosted_Service/hosted-service-billing.mdx (1)
6-6: Description clearly outlines the pricing range.The description effectively conveys the scope from free development to production options, helping readers quickly assess relevance.
docs/HyperIndex/contract-import.md (1)
6-6: Description emphasizes automation and universality.The description highlights the core benefit (autogenerate) and scope ("any smart contract"), making it clear this is an accessible entry point.
docs/HyperIndex/fuel/fuel.md (1)
1-7: Description metadata looks good.The YAML front matter addition is clear, descriptive, and accurately summarizes the page's purpose for LLM crawlers and social preview systems.
docs/HyperIndex/Tutorials/tutorial-scaffold-eth-2.md (1)
1-7: Description metadata is well-crafted.The description captures the key value proposition and is appropriate for SEO and social previews.
docs/HyperIndex/Guides/configuration-file.mdx (1)
1-7: Description metadata addition is suitable.Clear, action-oriented description that accurately represents the documentation scope.
docs/HyperIndex/Tutorials/greeter-tutorial.md (1)
1-7: Description metadata fits the page well.The description provides good context about the tutorial's focus and expected outcomes.
docs/HyperIndex/Examples/example-liquidation-metrics.md (1)
1-7: Description metadata is appropriate.Concise and informative description for LLM systems and social card previews.
docs/HyperIndex/Advanced/persisted_files.md (1)
1-7: Description metadata addition is solid.Accurately captures the technical focus of the page with a clear imperative tone.
docs/HyperIndex/Troubleshoot/logging.mdx (1)
1-7: Description metadata is well-written.Good summary of the logging configuration and troubleshooting focus.
docs/HyperIndex/Advanced/metadata-query.md (1)
6-6: Description field added correctly.The description is concise, accurate, and well-suited for metadata/LLM use. It clearly summarizes the page's content.
docs/HyperIndex/Advanced/performance/database-performance-optimization.md (1)
6-6: Description field added correctly.Concise and accurate summary of the page's core topics. Metadata addition is well-executed.
docs/HyperSync/hypersync-query.md (1)
6-6: Description field added correctly.Captures the page's core capabilities (query construction, filtering, joins) accurately and concisely.
docs/HyperIndex/Advanced/performance/benchmarking.md (1)
6-6: Description field added correctly.Accurately summarizes the page's purpose: benchmarking, bottleneck identification, and performance optimization.
docs/HyperIndex/Guides/block-handlers.md (1)
6-6: Description field added correctly.Accurately captures the onBlock API's purpose and dual modes (every block or intervals). Metadata quality is high.
docs/HyperIndex/Tutorials/tutorial-indexing-fuel.md (1)
6-6: Description field added correctly.Tutorial-appropriate description that references the concrete example (Sway Farm) and outcome. Metadata is clear and helpful.
docs/HyperIndex/overview.md (1)
6-6: Description field added correctly.Captures HyperIndex's key value propositions (speed, multichain, real-time data). Metadata is compelling and accurate for overview page.
docs/HyperIndex/Advanced/performance/latency-at-head.md (1)
6-6: Description field added correctly.Accurately summarizes page content: maintaining low latency at chain head with reliable multi-chain sync. High-quality metadata.
docs/HyperRPC/overview-hyperrpc.md (1)
6-6: Description metadata addition looks good.The added description is concise, action-oriented, and accurately represents the page content. It's appropriate for LLM crawlers and social link previews.
docs/HyperSync/tutorial-address-transactions.md (1)
6-6: Description is well-tailored to content.Accurately captures the tutorial's focus on address transaction analysis with clear value proposition.
docs/HyperIndex/Guides/contract-state.md (1)
6-6: Comprehensive and specific description.The description effectively highlights the key techniques covered (RPC, multicall, caching) and communicates practical value.
docs/HyperIndex/Examples/example-aerodrome-velodrome.md (1)
6-6: Description accurately reflects example scope.Highlights multi-chain capability and key tracked entities (pools, swaps, liquidity).
docs/HyperIndex/Troubleshoot/reserved-words.md (1)
6-6: Clear problem-solution description.Effectively frames the issue and communicates that this guide provides both diagnostics and remediation steps.
docs/HyperIndex/Guides/ipfs.md (1)
6-6: Description clearly positions the guide's value.Highlights the NFT metadata integration scenario and the benefit of combining on-chain and off-chain data.
docs/HyperSync/hypersync-curl-examples.md (1)
6-6: Description emphasizes accessibility.The emphasis on "quickly" and direct curl commands aligns well with the guide's positioning as a low-barrier-to-entry approach.
docs/HyperIndex/Advanced/config-schema-reference.md (2)
6-6: Concise and appropriate schema reference description.
9-9: Minor clarification improves accuracy.Removing "JSON" from "JSON Schema" simplifies the phrasing while maintaining accuracy—the document is a reference for the schema, not JSON itself.
docs/HyperIndex/Guides/navigating-hasura.md (1)
1-7: ✓ Description field appropriately added.The metadata addition is accurate and concise. The description clearly conveys the page's purpose without exceeding typical SEO preview limits.
docs/HyperIndex/Advanced/hypersync.md (2)
6-6: ✓ Description metadata is accurate and well-scoped.The description appropriately summarizes the page's primary focus on HyperSync as a data source.
91-118: ✓ Fallback RPC configuration example enhances documentation clarity.The added configuration example is well-commented and demonstrates both simple (single URL) and flexible (multi-entry with parameters) approaches. The version note (2.14.0+) appropriately documents feature availability. The 20-second timeout threshold mentioned is helpful context for understanding failover behavior.
docs/HyperIndex/Examples/example-uniswap-v4.md (1)
6-6: ✓ Description field appropriately added.The metadata succinctly captures the multi-chain real-time indexing focus of the example, aligning with the page's key features section.
docs/HyperIndex/licensing.md (1)
6-6: ✓ Description field comprehensively added.The metadata effectively summarizes the page's core licensing principles—self-hosting, code openness, and service protection—in a clear, accessible manner suitable for previews.
docs/HyperIndex/Troubleshoot/error-codes.md (1)
6-6: ✓ Description field appropriately added.The metadata clearly conveys the page's dual purpose as both a reference guide and troubleshooting resource, with emphasis on clarity and actionability.
docs/HyperIndex/Examples/example-sablier.md (1)
6-6: ✓ Description field appropriately added.The metadata clearly encapsulates the page's focus on professional Sablier indexer implementations across multiple chains and streaming use cases.
docs/HyperIndex/Troubleshoot/common-issues.md (1)
6-6: ✓ Description field appropriately added.The metadata accurately reflects the page's comprehensive troubleshooting scope across setup, runtime, and configuration domains, with emphasis on practical solutions.
docs/HyperIndex/Advanced/performance/historical-sync.md (1)
6-6: ✓ Description field appropriately added.The metadata concisely captures the page's central theme of optimizing historical sync performance and efficiency in HyperIndex.
docs/HyperSync/hypersync-clients.md (1)
6-6: Metadata addition looks good.The description is concise and accurately summarizes the page content for LLM crawlers and social previews.
docs/HyperIndex/Tutorials/price-data.md (1)
6-6: Metadata addition is appropriate.The description clearly conveys the tutorial's focus on multi-source price data integration.
docs/HyperSync/hypersync-usage.md (1)
6-6: Metadata addition is fitting.The description succinctly captures the guide's core topics: querying, filtering, and decoding HyperSync data.
docs/HyperIndex/Advanced/terminology.md (1)
6-6: Metadata addition is well-suited.The description appropriately describes a terminology reference page for developers.
docs/HyperIndex/Advanced/performance/index.md (1)
6-6: Metadata addition is appropriate.The description accurately captures the page's focus on performance optimization across multiple areas.
docs/HyperSync/HyperFuel/hyperfuel.md (1)
6-6: Metadata addition is fitting.The description concisely describes HyperFuel's purpose for Fuel network data querying and syncing.
docs/HyperIndex/Hosted_Service/hosted-service-deployment.md (1)
6-6: Metadata addition is well-aligned with page content.The description accurately summarizes deployment, management, and versioning guidance.
docs/HyperIndex/Hosted_Service/hosted-service.md (1)
6-6: Metadata addition is comprehensive and accurate.The description effectively conveys the hosted service's key benefits: managed infrastructure, Git-based deployments, monitoring, and multi-chain capabilities.
docs/HyperIndex/Hosted_Service/self-hosting.md (1)
6-6: Metadata addition looks good.The description accurately summarizes the self-hosting content (Docker, PostgreSQL, Hasura setup) and is appropriately concise for social previews and LLM crawlers. YAML formatting is correct.
docs/HyperSync/HyperFuel/hyperfuel-query.md (1)
6-6: Metadata addition is appropriate.The description accurately captures the page's purpose as an exhaustive reference for HyperFuel query fields and parameters. Suitable for social previews and LLM indexing. YAML formatting is correct.
| title: Supported Networks | ||
| sidebar_label: Supported Networks | ||
| slug: /hyperrpc-supported-networks | ||
| description: Explore HyperRPC supported blockchain network. |
There was a problem hiding this comment.
Minor grammar issue: Use plural form. The description should say "networks" (plural) not "network" (singular) since the page lists 50+ supported networks.
-description: Explore HyperRPC supported blockchain network.
+description: Explore HyperRPC supported blockchain networks.📝 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: Explore HyperRPC supported blockchain network. | |
| description: Explore HyperRPC supported blockchain networks. |
🤖 Prompt for AI Agents
In docs/HyperRPC/hyperrpc-supported-networks.md around line 6, the page
description uses the singular "network" but should use the plural "networks";
update the description line to read "Explore HyperRPC supported blockchain
networks." to match the content listing multiple networks.
2 participants
These will be used in lllms.txt & social preview of the link. These were needed so llm crawlers can understand what content will be in the given page. Also, social previews will look nice with this.
Summary by CodeRabbit