Rework Hosted Service docs to include features and usage policies#715
Rework Hosted Service docs to include features and usage policies#715moose-code merged 16 commits intomainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughThis PR restructures the HyperIndex Hosted Service documentation, introducing new pages for features and monitoring, reorganizing deployment guidance with prerequisites and continuous deployment sections, updating pricing documentation, and adding network/configuration entries across multiple LLM documentation files. Changes
Sequence Diagram(s)sequenceDiagram
actor User
participant Docs as Documentation Site
participant Deploy as Deployment Guide
participant Monitor as Monitoring Guide
participant Features as Features Page
User->>Docs: Access Hosted Service
Docs->>Deploy: View deployment workflow
Note over Deploy: Prerequisites & Requirements<br/>Configure → Deploy → Manage → Monitor
Deploy->>Monitor: Link to monitoring guide
Monitor->>User: Real-time metrics & alerts
Docs->>Features: Check available features
Features->>User: Plan-based feature availability
User->>Deploy: Return to deployment with feature context
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes The review involves multiple documentation restructures requiring verification of content accuracy and cross-link correctness, two new comprehensive documentation pages to assess for completeness, consistent network table updates across multiple files, and new configuration entries. While most changes are documentation-focused and homogeneous in nature, the structural reorganization and new pages demand careful attention to ensure the documentation flow and information architecture remain clear. Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 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 |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
docs/HyperIndex/Hosted_Service/hosted-service-features.md (4)
51-51: Add a blank line before the heading.The "### Alert Types" heading should be preceded by a blank line for proper markdown formatting and better readability.
Apply this diff:
- **Email** + ### Alert Types
92-92: Consider using a proper heading instead of bold text.The "Available on: Dedicated plans only" line uses bold emphasis instead of a proper markdown heading, which can affect document structure and accessibility.
Based on static analysis hints.
Consider one of these alternatives:
- Use a note/info block:
-**Available on: Dedicated plans only** +:::info Plan Availability +This feature is available on Dedicated plans only. +:::
- Or incorporate into the section heading:
-## Deployment Location Choice - -**Available on: Dedicated plans only** +## Deployment Location Choice (Dedicated Plans Only)
108-108: Consider using a proper heading instead of bold text.Similar to line 92, the "Available on: Dedicated plans only" line uses bold emphasis. Consider using a consistent pattern across all sections.
Based on static analysis hints.
Apply the same solution as suggested for line 92, choosing one consistent pattern for all "Available on" notes throughout the document.
120-120: Consider using a proper heading instead of bold text.The "Available on: Dedicated plans only (additional cost)" line follows the same pattern. For consistency, apply the same solution used for lines 92 and 108.
Based on static analysis hints.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
docs/HyperIndex/Hosted_Service/hosted-service-billing.mdx(2 hunks)docs/HyperIndex/Hosted_Service/hosted-service-deployment.md(2 hunks)docs/HyperIndex/Hosted_Service/hosted-service-features.md(1 hunks)docs/HyperIndex/Hosted_Service/hosted-service.md(2 hunks)sidebarsHyperIndex.js(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
docs/HyperIndex/Hosted_Service/hosted-service-features.md
92-92: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
108-108: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
120-120: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🔇 Additional comments (5)
docs/HyperIndex/Hosted_Service/hosted-service-billing.mdx (1)
14-59: Excellent reorganization of pricing information.The new "Pricing Tiers" structure with the comprehensive feature availability table significantly improves clarity. The table provides an at-a-glance comparison of all tiers with specific limits and features, making it much easier for users to understand what's included in each plan.
docs/HyperIndex/Hosted_Service/hosted-service.md (2)
12-13: Good addition of tier overview.The new paragraph effectively introduces the multi-tier hosting model and sets expectations for the features available, providing good context before diving into the detailed features list.
46-52: Well-structured Getting Started section.The new Getting Started section with clear links to Features, Deployment Guide, Pricing & Billing, and Self-Hosting provides excellent navigation for users and aligns well with the documentation reorganization.
docs/HyperIndex/Hosted_Service/hosted-service-deployment.md (2)
12-47: Excellent documentation of deployment limits and policies.The new Prerequisites section clearly outlines:
- Deployment limits per tier
- Development tier fair usage policy
- Hard and soft limits with specific thresholds
- Two-stage deletion process with timeline
The warning about timeline changes being subject to modification is appropriate and sets proper expectations. This transparency helps users understand the constraints and plan accordingly.
49-86: Well-organized step-by-step deployment instructions.The reorganized deployment instructions follow a clear, logical flow from initial setup through configuration to deployment and management. The separation into distinct phases (Initial Setup, Configure Your Indexer, Deploy Your Code, Manage Your Deployment) makes the process easy to follow.
The tips about multiple indexers per repository and monorepo configuration are placed appropriately where users need them.
There was a problem hiding this comment.
Actionable comments posted: 7
🧹 Nitpick comments (6)
docs/HyperIndex/Hosted_Service/hosted-service-deployment.md (6)
34-51: Fix MD036: use headings/admonitions instead of emphasis for deletion rules.Convert bold/italic “pseudo‑headings” into real headings and a note to satisfy markdownlint and improve structure.
Based on static analysis hints (MD036 at Lines 43, 47). Apply:
-**Automatic Deletion Rules:** +#### Automatic deletion rules @@ -**When soft limits are breached, the two-stage deletion process begins** +#### When soft limits are breached, the two-stage deletion process begins @@ -**Two-Stage Deletion Process:** +#### Two-stage deletion process @@ -_Applies to development deployments that breach the soft limits_ +:::note +Applies to development deployments that breach the soft limits. +:::
22-22: Typo: “Github” → “GitHub”.Casing fix.
-- **Github Repository**: The repository must be no larger than `100MB` +- **GitHub Repository**: The repository must be no larger than `100MB`
26-31: Clarify “Deployments per indexer” and fix minor spacing.
- Remove double space after colon.
- Clarify whether “3 deployments per indexer” means concurrent active deployments, total saved versions, or environments.
-- **Deployments per indexer**: 3 deployments per indexer +- **Deployments per indexer**: 3 deployments per indexerPlease add a short note explaining what counts toward this limit (active vs. historical, paused, failed).
16-21: Prerequisites: consider specifying Node.js support and pnpm range.
- Add supported Node.js LTS versions used by the builder/runtime.
- If possible, express pnpm compatibility as a range (e.g., “pnpm 9.10.x”) or “≥ 9.10.0” if that’s accurate.
115-115: Spelling: “Continous” → “Continuous”.-### Continous Configuration +### Continuous Configuration
136-142: ENV variables: clarify enforcement ofENVIO_prefix.State whether non‑prefixed variables are ignored and whether names are case‑sensitive. If secrets redaction applies in logs, mention it.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (14)
docs/HyperIndex-Hosted-LLM/hosted-service-complete.mdx(1 hunks)docs/HyperIndex/Hosted_Service/hosted-service-billing.mdx(2 hunks)docs/HyperIndex/Hosted_Service/hosted-service-deployment.md(1 hunks)docs/HyperIndex/Hosted_Service/hosted-service-features.md(1 hunks)docs/HyperIndex/Hosted_Service/hosted-service-monitoring.md(1 hunks)docs/HyperIndex/Hosted_Service/hosted-service.md(1 hunks)docs/HyperIndex/Hosted_Service/self-hosting.md(1 hunks)docs/HyperRPC/hyperrpc-supported-networks.md(0 hunks)docs/HyperSync/hypersync-supported-networks.md(0 hunks)docusaurus.config.js(2 hunks)sidebarsHyperIndex.js(1 hunks)sidebarsHyperIndexHostedLLM.js(1 hunks)src/pages/index.js(2 hunks)supported-networks.json(1 hunks)
💤 Files with no reviewable changes (2)
- docs/HyperRPC/hyperrpc-supported-networks.md
- docs/HyperSync/hypersync-supported-networks.md
✅ Files skipped from review due to trivial changes (1)
- sidebarsHyperIndexHostedLLM.js
🚧 Files skipped from review as they are similar to previous changes (1)
- sidebarsHyperIndex.js
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
docs/HyperIndex/Hosted_Service/hosted-service.md
21-21: Link text should be descriptive
(MD059, descriptive-link-text)
docs/HyperIndex/Hosted_Service/hosted-service-deployment.md
43-43: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
47-47: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
docs/HyperIndex/Hosted_Service/hosted-service-features.md
98-98: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
114-114: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
126-126: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
docs/HyperIndex/Hosted_Service/hosted-service-monitoring.md
21-21: Link text should be descriptive
(MD059, descriptive-link-text)
🔇 Additional comments (8)
docs/HyperIndex/Hosted_Service/hosted-service-billing.mdx (1)
14-78: LGTM! Excellent documentation structure.The reworked pricing and billing documentation is comprehensive and well-organized:
- Clear tier structure with explicit pricing
- Comprehensive feature availability matrix
- Appropriate warnings for development tier usage
- Good cross-references to related documentation
docs/HyperIndex-Hosted-LLM/hosted-service-complete.mdx (1)
1-533: Excellent LLM-friendly consolidation.The consolidated documentation provides comprehensive coverage of all Hosted Service topics in a single file optimized for LLM consumption. Well-structured and thorough.
docusaurus.config.js (1)
498-509: LGTM! Plugin configuration is correct.The new HyperIndex-Hosted-Service-LLM plugin configuration is properly structured and follows the existing pattern for LLM-focused documentation.
src/pages/index.js (1)
35-37: LGTM! Homepage links are well-integrated.The new Hosted Service documentation links are properly added to both the Regular Documentation and LLM-Friendly Documentation sections, maintaining consistency with the existing link structure.
Also applies to: 66-71
docs/HyperIndex/Hosted_Service/hosted-service-monitoring.md (1)
1-87: LGTM! Comprehensive monitoring documentation.The monitoring guide provides thorough coverage of dashboard metrics, deployment status indicators, error detection, logging, and built-in alerts. Well-structured with appropriate cross-references to related documentation.
docs/HyperIndex/Hosted_Service/hosted-service-features.md (1)
1-148: LGTM! Excellent feature documentation.The features page provides comprehensive coverage of production-ready capabilities including:
- Clear plan availability notices
- Detailed technical implementation notes for IP/Domain whitelisting
- Built-in alerts with version requirements and notification channels
- Zero-downtime deployment workflow
- Enterprise features (deployment location, direct DB access, analytics)
Well-structured with appropriate warnings and cross-references.
docs/HyperIndex/Hosted_Service/hosted-service.md (1)
12-61: LGTM! Excellent documentation restructuring.The restructured overview provides:
- Clear deployment options (fully managed vs self-hosting)
- Comprehensive key features list
- Detailed deployment model explanation
- Well-organized getting started section
The multi-section layout effectively guides users to the appropriate detailed documentation.
docs/HyperIndex/Hosted_Service/hosted-service-deployment.md (1)
57-59: All linked docs and images verified
All referenced documentation and images exist in the repository; no missing files or broken links detected.
docusaurus.config.js
Outdated
| { | ||
| to: "docs/HyperIndex/overview", | ||
| label: "HyperIndex Docs", | ||
| position: "left", | ||
| }, |
There was a problem hiding this comment.
Remove duplicate navbar item.
Lines 331-335 duplicate the navbar item already defined at lines 317-320. This creates duplicate "HyperIndex Docs" entries in the navigation.
Apply this diff to remove the duplicate:
- {
- to: "docs/HyperIndex/overview",
- label: "HyperIndex Docs",
- position: "left",
- },📝 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.
| { | |
| to: "docs/HyperIndex/overview", | |
| label: "HyperIndex Docs", | |
| position: "left", | |
| }, |
🤖 Prompt for AI Agents
In docusaurus.config.js around lines 331 to 335 there is a duplicate navbar
entry for "HyperIndex Docs" (same item already defined at lines 317-320); remove
the redundant object block at lines 331-335 so only the original navbar item
remains, ensuring no other navbar structure or commas are left malformed after
deletion.
supported-networks.json
Outdated
| "supported-networks/local-anvil", | ||
| "supported-networks/local-hardhat", | ||
| "supported-networks/0g-newton-testnet","supported-networks/abstract","supported-networks/aleph-zero-evm","supported-networks/altlayer-op-demo-testnet","supported-networks/ancient8","supported-networks/arbitrum","supported-networks/arbitrum-blueberry","supported-networks/arbitrum-nova","supported-networks/arbitrum-sepolia","supported-networks/artela-testnet","supported-networks/arthera-mainnet","supported-networks/asset-chain-mainnet","supported-networks/astar-zkevm","supported-networks/astar-zkyoto","supported-networks/aurora","supported-networks/aurora-turbo","supported-networks/avalanche","supported-networks/b2-hub-testnet","supported-networks/b3","supported-networks/b3-sepolia-testnet","supported-networks/base","supported-networks/base-sepolia","supported-networks/beam","supported-networks/berachain","supported-networks/berachain-artio-testnet","supported-networks/berachain-bartio","supported-networks/bevm-mainnet","supported-networks/bevm-testnet","supported-networks/bitfinity-mainnet","supported-networks/bitfinity-testnet","supported-networks/bitgert-mainnet","supported-networks/bitlayer","supported-networks/blast","supported-networks/blast-sepolia","supported-networks/bob-mainnet","supported-networks/boba","supported-networks/boba-bnb-mainnet","supported-networks/botanix-testnet","supported-networks/bsc","supported-networks/bsc-testnet","supported-networks/canto","supported-networks/canto-testnet","supported-networks/celo","supported-networks/celo-alfajores-testnet","supported-networks/chainweb-testnet-20","supported-networks/chainweb-testnet-21","supported-networks/chainweb-testnet-22","supported-networks/chainweb-testnet-23","supported-networks/chainweb-testnet-24","supported-networks/chiliz","supported-networks/chiliz-testnet-spicy","supported-networks/citrea-devnet","supported-networks/citrea-testnet","supported-networks/core","supported-networks/creator-testnet","supported-networks/cronos-zkevm","supported-networks/cronos-zkevm-testnet","supported-networks/crossfi-mainnet","supported-networks/crossfi-mainnet","supported-networks/crossfi-testnet","supported-networks/curtis","supported-networks/cyber","supported-networks/damon","supported-networks/degen-chain","supported-networks/dfk-chain","supported-networks/dogechain-mainnet","supported-networks/dogechain-testnet","supported-networks/dos-chain","supported-networks/energy-web","supported-networks/eos","supported-networks/eth","supported-networks/etherlink-testnet","supported-networks/exosama","supported-networks/fantom","supported-networks/fantom-testnet","supported-networks/flare","supported-networks/flare-songbird","supported-networks/flow","supported-networks/flow-testnet","supported-networks/fraxtal","supported-networks/fuel-mainnet","supported-networks/fuel-testnet","supported-networks/fuji","supported-networks/galadriel-devnet","supported-networks/gnosis","supported-networks/gnosis-chiado","supported-networks/gravity-alpha-mainnet","supported-networks/harmony-shard-0","supported-networks/heco-chain","supported-networks/holesky","supported-networks/hyperliquid","supported-networks/immutable-zkevm","supported-networks/immutable-zkevm-testnet","supported-networks/ink","supported-networks/iotex-network","supported-networks/japan-open-chain","supported-networks/kaia","supported-networks/kakarot-starknet-sepolia","supported-networks/kroma","supported-networks/layeredge-testnet","supported-networks/lightlink-pegasus-testnet","supported-networks/lightlink-phoenix","supported-networks/linea","supported-networks/lisk","supported-networks/lukso","supported-networks/lukso-testnet","supported-networks/manta","supported-networks/manta-pacific-sepolia","supported-networks/mantle","supported-networks/megaeth-testnet","supported-networks/merlin","supported-networks/metall2","supported-networks/meter-mainnet","supported-networks/meter-testnet","supported-networks/mev-commit","supported-networks/mint-mainnet","supported-networks/mode","supported-networks/monad-testnet","supported-networks/moonbase-alpha","supported-networks/moonbeam","supported-networks/morph","supported-networks/nautilus","supported-networks/neo-x-testnet","supported-networks/nibiru-testnet","supported-networks/now-chaint","supported-networks/oasis-emerald","supported-networks/oasis-sapphire","supported-networks/onigiri-subnet","supported-networks/onigiri-test-subnet","supported-networks/ontology-mainnet","supported-networks/ontology-testnet","supported-networks/op-celestia-raspberry","supported-networks/opbnb","supported-networks/optimism","supported-networks/optimism-sepolia","supported-networks/optopia","supported-networks/peaq","supported-networks/plume","supported-networks/polygon","supported-networks/polygon-amoy","supported-networks/polygon-zkevm","supported-networks/polygon-zkevm-cardona-testnet","supported-networks/public-goods-network","supported-networks/pulsechain","supported-networks/puppynet-shibarium","supported-networks/ronin","supported-networks/rootstock","supported-networks/saakuru","supported-networks/satoshivm","supported-networks/scroll","supported-networks/scroll-sepolia","supported-networks/sentient-testnet","supported-networks/sepolia","supported-networks/shibarium","supported-networks/shimmer-evm","supported-networks/skale-europa","supported-networks/soneium","supported-networks/sonic","supported-networks/sophon","supported-networks/sophon-testnet","supported-networks/stratovm-testnet","supported-networks/superseed","supported-networks/superseed-sepolia-testnet","supported-networks/swell","supported-networks/taiko","supported-networks/tangle","supported-networks/tanssi-demo","supported-networks/taraxa","supported-networks/telos-evm-mainnet","supported-networks/telos-evm-testnet","supported-networks/torus-mainnet","supported-networks/torus-testnet","supported-networks/unichain","supported-networks/unichain-sepolia","supported-networks/unicorn-ultra-nebulas-testnet","supported-networks/velas-mainnet","supported-networks/viction","supported-networks/worldchain","supported-networks/x-layer-mainnet","supported-networks/x-layer-testnet","supported-networks/xdc","supported-networks/xdc-testnet","supported-networks/zeta","supported-networks/zeta-testnet","supported-networks/zircuit","supported-networks/zklink-nova-mainnet","supported-networks/zksync","supported-networks/zksync-sepolia-testnet","supported-networks/zora","supported-networks/zora-sepolia"]} No newline at end of file | ||
| "supported-networks/0g-newton-testnet","supported-networks/abstract","supported-networks/aleph-zero-evm","supported-networks/altlayer-op-demo-testnet","supported-networks/ancient8","supported-networks/arbitrum","supported-networks/arbitrum-blueberry","supported-networks/arbitrum-nova","supported-networks/arbitrum-sepolia","supported-networks/artela-testnet","supported-networks/arthera-mainnet","supported-networks/asset-chain-mainnet","supported-networks/astar-zkevm","supported-networks/astar-zkyoto","supported-networks/aurora","supported-networks/aurora-turbo","supported-networks/avalanche","supported-networks/b2-hub-testnet","supported-networks/b3","supported-networks/b3-sepolia-testnet","supported-networks/base","supported-networks/base-sepolia","supported-networks/beam","supported-networks/berachain","supported-networks/berachain-artio-testnet","supported-networks/berachain-bartio","supported-networks/bevm-mainnet","supported-networks/bevm-testnet","supported-networks/bitfinity-mainnet","supported-networks/bitfinity-testnet","supported-networks/bitgert-mainnet","supported-networks/bitlayer","supported-networks/blast","supported-networks/blast-sepolia","supported-networks/bob-mainnet","supported-networks/boba","supported-networks/boba-bnb-mainnet","supported-networks/botanix-testnet","supported-networks/bsc","supported-networks/bsc-testnet","supported-networks/canto","supported-networks/canto-testnet","supported-networks/celo","supported-networks/celo-alfajores-testnet","supported-networks/chainweb-testnet-20","supported-networks/chainweb-testnet-21","supported-networks/chainweb-testnet-22","supported-networks/chainweb-testnet-23","supported-networks/chainweb-testnet-24","supported-networks/chiliz","supported-networks/chiliz-testnet-spicy","supported-networks/citrea-devnet","supported-networks/citrea-testnet","supported-networks/core","supported-networks/creator-testnet","supported-networks/cronos-zkevm","supported-networks/cronos-zkevm-testnet","supported-networks/crossfi-mainnet","supported-networks/crossfi-mainnet","supported-networks/crossfi-testnet","supported-networks/curtis","supported-networks/cyber","supported-networks/damon","supported-networks/degen-chain","supported-networks/dfk-chain","supported-networks/dogechain-mainnet","supported-networks/dogechain-testnet","supported-networks/dos-chain","supported-networks/energy-web","supported-networks/eos","supported-networks/eth","supported-networks/etherlink-testnet","supported-networks/exosama","supported-networks/fantom","supported-networks/fantom-testnet","supported-networks/flare","supported-networks/flare-songbird","supported-networks/flow","supported-networks/flow-testnet","supported-networks/fraxtal","supported-networks/fuel-mainnet","supported-networks/fuel-testnet","supported-networks/fuji","supported-networks/gnosis","supported-networks/gnosis-chiado","supported-networks/gravity-alpha-mainnet","supported-networks/harmony-shard-0","supported-networks/heco-chain","supported-networks/holesky","supported-networks/hyperliquid","supported-networks/immutable-zkevm","supported-networks/immutable-zkevm-testnet","supported-networks/ink","supported-networks/iotex-network","supported-networks/japan-open-chain","supported-networks/kaia","supported-networks/kakarot-starknet-sepolia","supported-networks/kroma","supported-networks/layeredge-testnet","supported-networks/lightlink-pegasus-testnet","supported-networks/lightlink-phoenix","supported-networks/linea","supported-networks/lisk","supported-networks/lukso","supported-networks/lukso-testnet","supported-networks/manta","supported-networks/manta-pacific-sepolia","supported-networks/mantle","supported-networks/megaeth-testnet","supported-networks/merlin","supported-networks/metall2","supported-networks/meter-mainnet","supported-networks/meter-testnet","supported-networks/mev-commit","supported-networks/mint-mainnet","supported-networks/mode","supported-networks/monad-testnet","supported-networks/moonbase-alpha","supported-networks/moonbeam","supported-networks/morph","supported-networks/nautilus","supported-networks/neo-x-testnet","supported-networks/nibiru-testnet","supported-networks/now-chaint","supported-networks/oasis-emerald","supported-networks/oasis-sapphire","supported-networks/onigiri-subnet","supported-networks/onigiri-test-subnet","supported-networks/ontology-mainnet","supported-networks/ontology-testnet","supported-networks/op-celestia-raspberry","supported-networks/opbnb","supported-networks/optimism","supported-networks/optimism-sepolia","supported-networks/optopia","supported-networks/peaq","supported-networks/plume","supported-networks/polygon","supported-networks/polygon-amoy","supported-networks/polygon-zkevm","supported-networks/polygon-zkevm-cardona-testnet","supported-networks/public-goods-network","supported-networks/pulsechain","supported-networks/puppynet-shibarium","supported-networks/ronin","supported-networks/rootstock","supported-networks/saakuru","supported-networks/satoshivm","supported-networks/scroll","supported-networks/scroll-sepolia","supported-networks/sentient-testnet","supported-networks/sepolia","supported-networks/shibarium","supported-networks/shimmer-evm","supported-networks/skale-europa","supported-networks/soneium","supported-networks/sonic","supported-networks/sophon","supported-networks/sophon-testnet","supported-networks/stratovm-testnet","supported-networks/superseed","supported-networks/superseed-sepolia-testnet","supported-networks/swell","supported-networks/taiko","supported-networks/tangle","supported-networks/tanssi-demo","supported-networks/taraxa","supported-networks/telos-evm-mainnet","supported-networks/telos-evm-testnet","supported-networks/torus-mainnet","supported-networks/torus-testnet","supported-networks/unichain","supported-networks/unicorn-ultra-nebulas-testnet","supported-networks/velas-mainnet","supported-networks/viction","supported-networks/worldchain","supported-networks/x-layer-mainnet","supported-networks/x-layer-testnet","supported-networks/xdc","supported-networks/xdc-testnet","supported-networks/zeta","supported-networks/zeta-testnet","supported-networks/zircuit","supported-networks/zklink-nova-mainnet","supported-networks/zksync","supported-networks/zksync-sepolia-testnet","supported-networks/zora","supported-networks/zora-sepolia"]} No newline at end of file |
There was a problem hiding this comment.
🧩 Analysis chain
Duplicate entry and potential slug issues; please de-dupe, validate, and reformat
- Duplicate: "supported-networks/crossfi-mainnet" appears twice. Remove one to avoid duplicate nav/items.
- Please verify these slugs exist (possible typos): "berachain-bartio", "metall2", "now-chaint". They look off vs commonly used names and may not have corresponding docs.
Minimal fix for the duplicate:
- ... "supported-networks/crossfi-mainnet","supported-networks/crossfi-mainnet","supported-networks/crossfi-testnet" ...
+ ... "supported-networks/crossfi-mainnet","supported-networks/crossfi-testnet" ...Also recommended for maintainability:
- One entry per line and (optionally) alphabetical sort to reduce churn.
- Add a CI check to enforce uniqueness and presence of corresponding docs.
Run this script to validate JSON, detect duplicates, and find missing doc pages for each slug:
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# 1) Validate JSON
jq . supported-networks.json >/dev/null
# 2) Show duplicates
echo "== Duplicates in supportedNetworks =="
dups=$(jq -r '.supportedNetworks[]' supported-networks.json | sort | uniq -d || true)
if [ -n "$dups" ]; then
echo "$dups"
else
echo "None"
fi
# 3) Verify that each referenced doc exists somewhere in the repo
# We consider these as valid locations:
# - **/supported-networks/<slug>.md
# - **/supported-networks/<slug>.mdx
# - **/supported-networks/<slug>/index.md
# - **/supported-networks/<slug>/index.mdx
python - <<'PY'
import json, os, sys
with open('supported-networks.json') as f:
data = json.load(f)
def exists_for_slug(slug:str)->bool:
for root, dirs, files in os.walk('.'):
# skip common large/irrelevant dirs
if any(skip in root for skip in ('/.git', '/node_modules', '/build', '/dist', '/.next', '/out')):
continue
# folder-based page: supported-networks/<slug>/index.(md|mdx)
if root.replace('\\','/').endswith(f'/supported-networks/{slug}'):
if 'index.md' in files or 'index.mdx' in files:
return True
# file-based page: supported-networks/<slug>.md(x)
if '/supported-networks/' in root.replace('\\','/'):
if f'{slug}.md' in files or f'{slug}.mdx' in files:
return True
return False
missing = []
nonconforming = []
for p in data.get('supportedNetworks', []):
if not isinstance(p, str) or not p.startswith('supported-networks/'):
nonconforming.append(p)
continue
slug = p.split('/', 1)[1]
if not exists_for_slug(slug):
missing.append(slug)
if nonconforming:
print("Non-conforming entries (not starting with supported-networks/):")
for n in nonconforming:
print(" -", n)
if missing:
print("Missing docs for slugs:")
for m in missing:
print(" -", m)
else:
print("All referenced slugs have corresponding docs.")
PYLength of output: 3095
Remove duplicate entry and add missing documentation
- Duplicate: remove one of the two
"supported-networks/crossfi-mainnet"entries. - Missing docs: script found no pages for any slug under
supported-networks/<slug>.md(x)or<slug>/index.md(x); add corresponding documentation for all referenced slugs.
- ...,"supported-networks/crossfi-mainnet","supported-networks/crossfi-mainnet","supported-networks/crossfi-testnet"...
+ ...,"supported-networks/crossfi-mainnet","supported-networks/crossfi-testnet"...- Add a CI check to enforce unique entries and validate that each slug has a matching doc file.
📝 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.
| "supported-networks/0g-newton-testnet","supported-networks/abstract","supported-networks/aleph-zero-evm","supported-networks/altlayer-op-demo-testnet","supported-networks/ancient8","supported-networks/arbitrum","supported-networks/arbitrum-blueberry","supported-networks/arbitrum-nova","supported-networks/arbitrum-sepolia","supported-networks/artela-testnet","supported-networks/arthera-mainnet","supported-networks/asset-chain-mainnet","supported-networks/astar-zkevm","supported-networks/astar-zkyoto","supported-networks/aurora","supported-networks/aurora-turbo","supported-networks/avalanche","supported-networks/b2-hub-testnet","supported-networks/b3","supported-networks/b3-sepolia-testnet","supported-networks/base","supported-networks/base-sepolia","supported-networks/beam","supported-networks/berachain","supported-networks/berachain-artio-testnet","supported-networks/berachain-bartio","supported-networks/bevm-mainnet","supported-networks/bevm-testnet","supported-networks/bitfinity-mainnet","supported-networks/bitfinity-testnet","supported-networks/bitgert-mainnet","supported-networks/bitlayer","supported-networks/blast","supported-networks/blast-sepolia","supported-networks/bob-mainnet","supported-networks/boba","supported-networks/boba-bnb-mainnet","supported-networks/botanix-testnet","supported-networks/bsc","supported-networks/bsc-testnet","supported-networks/canto","supported-networks/canto-testnet","supported-networks/celo","supported-networks/celo-alfajores-testnet","supported-networks/chainweb-testnet-20","supported-networks/chainweb-testnet-21","supported-networks/chainweb-testnet-22","supported-networks/chainweb-testnet-23","supported-networks/chainweb-testnet-24","supported-networks/chiliz","supported-networks/chiliz-testnet-spicy","supported-networks/citrea-devnet","supported-networks/citrea-testnet","supported-networks/core","supported-networks/creator-testnet","supported-networks/cronos-zkevm","supported-networks/cronos-zkevm-testnet","supported-networks/crossfi-mainnet","supported-networks/crossfi-mainnet","supported-networks/crossfi-testnet","supported-networks/curtis","supported-networks/cyber","supported-networks/damon","supported-networks/degen-chain","supported-networks/dfk-chain","supported-networks/dogechain-mainnet","supported-networks/dogechain-testnet","supported-networks/dos-chain","supported-networks/energy-web","supported-networks/eos","supported-networks/eth","supported-networks/etherlink-testnet","supported-networks/exosama","supported-networks/fantom","supported-networks/fantom-testnet","supported-networks/flare","supported-networks/flare-songbird","supported-networks/flow","supported-networks/flow-testnet","supported-networks/fraxtal","supported-networks/fuel-mainnet","supported-networks/fuel-testnet","supported-networks/fuji","supported-networks/gnosis","supported-networks/gnosis-chiado","supported-networks/gravity-alpha-mainnet","supported-networks/harmony-shard-0","supported-networks/heco-chain","supported-networks/holesky","supported-networks/hyperliquid","supported-networks/immutable-zkevm","supported-networks/immutable-zkevm-testnet","supported-networks/ink","supported-networks/iotex-network","supported-networks/japan-open-chain","supported-networks/kaia","supported-networks/kakarot-starknet-sepolia","supported-networks/kroma","supported-networks/layeredge-testnet","supported-networks/lightlink-pegasus-testnet","supported-networks/lightlink-phoenix","supported-networks/linea","supported-networks/lisk","supported-networks/lukso","supported-networks/lukso-testnet","supported-networks/manta","supported-networks/manta-pacific-sepolia","supported-networks/mantle","supported-networks/megaeth-testnet","supported-networks/merlin","supported-networks/metall2","supported-networks/meter-mainnet","supported-networks/meter-testnet","supported-networks/mev-commit","supported-networks/mint-mainnet","supported-networks/mode","supported-networks/monad-testnet","supported-networks/moonbase-alpha","supported-networks/moonbeam","supported-networks/morph","supported-networks/nautilus","supported-networks/neo-x-testnet","supported-networks/nibiru-testnet","supported-networks/now-chaint","supported-networks/oasis-emerald","supported-networks/oasis-sapphire","supported-networks/onigiri-subnet","supported-networks/onigiri-test-subnet","supported-networks/ontology-mainnet","supported-networks/ontology-testnet","supported-networks/op-celestia-raspberry","supported-networks/opbnb","supported-networks/optimism","supported-networks/optimism-sepolia","supported-networks/optopia","supported-networks/peaq","supported-networks/plume","supported-networks/polygon","supported-networks/polygon-amoy","supported-networks/polygon-zkevm","supported-networks/polygon-zkevm-cardona-testnet","supported-networks/public-goods-network","supported-networks/pulsechain","supported-networks/puppynet-shibarium","supported-networks/ronin","supported-networks/rootstock","supported-networks/saakuru","supported-networks/satoshivm","supported-networks/scroll","supported-networks/scroll-sepolia","supported-networks/sentient-testnet","supported-networks/sepolia","supported-networks/shibarium","supported-networks/shimmer-evm","supported-networks/skale-europa","supported-networks/soneium","supported-networks/sonic","supported-networks/sophon","supported-networks/sophon-testnet","supported-networks/stratovm-testnet","supported-networks/superseed","supported-networks/superseed-sepolia-testnet","supported-networks/swell","supported-networks/taiko","supported-networks/tangle","supported-networks/tanssi-demo","supported-networks/taraxa","supported-networks/telos-evm-mainnet","supported-networks/telos-evm-testnet","supported-networks/torus-mainnet","supported-networks/torus-testnet","supported-networks/unichain","supported-networks/unicorn-ultra-nebulas-testnet","supported-networks/velas-mainnet","supported-networks/viction","supported-networks/worldchain","supported-networks/x-layer-mainnet","supported-networks/x-layer-testnet","supported-networks/xdc","supported-networks/xdc-testnet","supported-networks/zeta","supported-networks/zeta-testnet","supported-networks/zircuit","supported-networks/zklink-nova-mainnet","supported-networks/zksync","supported-networks/zksync-sepolia-testnet","supported-networks/zora","supported-networks/zora-sepolia"]} | |
| ++ b/supported-networks.json | |
| @@ -1,1 +1,1 @@ | |
| ...,"supported-networks/crossfi-mainnet","supported-networks/crossfi-testnet",... |
🤖 Prompt for AI Agents
In supported-networks.json around line 5, the array contains a duplicate
"supported-networks/crossfi-mainnet" entry and the review also found missing
markdown docs for many slugs; remove the duplicate entry (keep a single
"supported-networks/crossfi-mainnet"), add corresponding documentation files for
each referenced slug (either supported-networks/<slug>.md or
supported-networks/<slug>/index.md with frontmatter and basic content), and add
a CI validation step that (1) fails on duplicate slugs and (2) verifies each
slug has a matching doc file, returning a non-zero exit and a clear error
message listing missing docs when validation fails.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/HyperIndex/Hosted_Service/hosted-service-deployment.md (1)
172-199: Align visual steps with numbered instructions.Visual Step 1 covers “Select Organization,” but the written Step 1 is “Log in with GitHub,” so the sequences no longer match. Either add a login screenshot as the first visual or shift the numbering/captions so each image aligns with the corresponding written step.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
docs/HyperIndex/Hosted_Service/hosted-service-deployment.md(1 hunks)docs/HyperIndex/Hosted_Service/hosted-service-features.md(1 hunks)docs/HyperIndex/Hosted_Service/hosted-service.md(1 hunks)docs/HyperIndex/Hosted_Service/self-hosting.md(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- docs/HyperIndex/Hosted_Service/hosted-service-features.md
🚧 Files skipped from review as they are similar to previous changes (2)
- docs/HyperIndex/Hosted_Service/hosted-service.md
- docs/HyperIndex/Hosted_Service/self-hosting.md
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/HyperIndex/Hosted_Service/hosted-service-deployment.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
docs/HyperIndex/Hosted_Service/hosted-service-deployment.md
43-43: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
47-47: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/HyperIndex/Hosted_Service/hosted-service-deployment.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
docs/HyperIndex/Hosted_Service/hosted-service-deployment.md
43-43: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
47-47: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
moose-code
left a comment
There was a problem hiding this comment.
Nice! Looking forward to getting this in
| ## Feature Availability by Tier | ||
|
|
||
| | Feature | Development | Production Small | Production Medium | Production Large | Dedicated | | ||
| |---------|-------------|------------------|-------------------|------------------|-----------| | ||
| | **Pricing & Limits** | | ||
| | Monthly cost | Free | $70 | $300 | $800 | Custom | | ||
| | Included indexing hours | 750 | 800 | 800 | 800 | Unlimited | | ||
| | Additional hours cost | - | $0.1/hour | $0.2/hour | $0.5/hour | Custom | | ||
| | Multichain networks | ∞ | 5 | 10 | 15 | ∞ | | ||
| | Query rate limit | 100/min | 250/min | 1,000/min | 2,000/min | 5,000/min | | ||
| | Approx storage capacity | 0.1M events | 1M events | 10M events | 100M events | Unlimited | | ||
| | Number of contracts | 100 | 1,000 | 10,000 | 50,000 | Unlimited | | ||
| | **Deployment Features** | | ||
| | Deployments per indexer | 3 | 5 | 5 | 5 | 5 | | ||
| | Static production endpoint | ❌ | ✅ | ✅ | ✅ | ✅ | | ||
| | **Security & Management** | | ||
| | IP/Domain whitelisting | ❌ | ✅ | ✅ | ✅ | ✅ | | ||
| | Built-in alerts | ❌ | ✅ | ✅ | ✅ | ✅ | | ||
| | **Infrastructure** | | ||
| | Backups | ❌ | ✅ | ✅ | ✅ | ✅ | | ||
| | Deployment location choice | ❌ | ❌ | ❌ | ❌ | ✅ | |
There was a problem hiding this comment.
Lets remove this? Having this in the UI and here is bound to make things go out of date? Thoughts?
| - **Dedicated** - Custom pricing for ultimate performance and control | ||
|
|
||
| :::warning Development Tier Disclaimer | ||
| The free development tier is intended for testing and development purposes only and should not be used as a production environment. Envio makes no guarantees regarding uptime, availability, or data persistence for deployments on the development tier. If you choose to use a development tier deployment in a production capacity, you do so entirely at your own risk. Envio assumes no liability or accountability for any downtime, data loss, or service interruptions that may occur on development tier deployments. |
There was a problem hiding this comment.
Add that dev tiers deployments only last for 30 days so they can't be used in production in any case?
| 5. **Connect to Repository**: Select the repository containing your indexer code | ||
| 6. **Configure Deployment Settings**: |
There was a problem hiding this comment.
We're getting rid of all the images? Is it worth replacing? Maybe can ask for help here from @nikbhintade
There was a problem hiding this comment.
The images are at the bottom
| **Capabilities:** | ||
| - Interactive, customizable dashboards through Metabase | ||
| - Variety of visualization options (charts, graphs, tables, maps) | ||
| - Fast analytical queries on large datasets via ClickHouse | ||
| - Ad-hoc SQL queries for data exploration | ||
| - Automated alerts based on data thresholds | ||
| - Team collaboration and report sharing | ||
| - Export capabilities for further analysis | ||
|
|
| Alert configuration is available for indexers deployed with version 2.24.0 or higher on paid production plans. | ||
| ::: | ||
|
|
||
| ## Visual Reference Guide |
There was a problem hiding this comment.
All the images are here step by step @moose-code
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
docs/HyperIndex/Hosted_Service/hosted-service-deployment.md (2)
34-47: Replace bold callouts with headingsThe bold phrases are triggering markdownlint MD036 (“no emphasis as heading”). Promote them to real headings and convert the introductory sentence to standard text so the lint job passes. Based on static analysis hints.
-**Automatic Deletion Rules:** +#### Automatic Deletion Rules ... -**When soft limits are breached, the two-stage deletion process begins** +When soft limits are breached, the two-stage deletion process begins: ... -**Two-Stage Deletion Process:** +#### Two-Stage Deletion Process
22-22: Correct GitHub casingBranding guidelines require “GitHub” with a capital H. Please update the bullet here and the heading on Line 175 accordingly.
-- **Github Repository**: The repository must be no larger than `100MB` +- **GitHub Repository**: The repository must be no larger than `100MB`-### Step 2: Install Github App +### Step 2: Install GitHub App
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/HyperIndex/Hosted_Service/hosted-service-deployment.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
docs/HyperIndex/Hosted_Service/hosted-service-deployment.md
43-43: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
47-47: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
d69688c to
1530254
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (3)
docs/HyperIndex/Hosted_Service/hosted-service-deployment.md (3)
22-22: Fix GitHub capitalization.The official branding requires "GitHub" (capital G and H), not "Github".
-- **Github Repository**: The repository must be no larger than `100MB` +- **GitHub Repository**: The repository must be no larger than `100MB`Based on past review comments.
175-175: Fix GitHub capitalization in step heading.The official branding requires "GitHub" (capital G and H), not "Github".
-### Step 2: Install Github App +### Step 2: Install GitHub AppBased on past review comments.
34-51: Convert bold text to proper markdown headings.Using bold text as headings triggers markdownlint MD036 violations. Convert these to proper markdown headings for better document structure and to pass linting.
-**Automatic Deletion Rules:** +#### Automatic Deletion Rules + - **Hard Limits**: - Deployments that exceed 20GB of storage will be automatically deleted - Deployments older than 30 days will be automatically deleted - **Soft Limits** (whichever comes first): - 100,000 events processed - 5GB storage used - no requests for 7 days -**When soft limits are breached, the two-stage deletion process begins** +When soft limits are breached, the two-stage deletion process begins: -**Two-Stage Deletion Process:** - -_Applies to development deployments that breach the soft limits_ +#### Two-Stage Deletion Process + +_Applies to development deployments that breach the soft limits:_ 1. **Grace Period (7 days)** - Your indexer continues to function normally, you receive notification about the upcoming deletion 2. **Read-Only Access (3 days)** - Indexer stops processing new data, existing data remains accessible for queries 3. **Full Deletion** - Indexer and all data are permanently deletedBased on past review comments.
🧹 Nitpick comments (3)
docs/HyperIndex/Hosted_Service/self-hosting.md (1)
28-28: Consider using plural form for consistency.The phrase "different infrastructure, tools and methods" mixes singular ("infrastructure") with plural forms ("tools and methods"). For grammatical consistency, consider:
-Self Hosting can be done with a variety of different infrastructure, tools and methods. +Self Hosting can be done with a variety of different infrastructures, tools and methods.docs/HyperIndex/Hosted_Service/hosted-service-billing.mdx (1)
36-63: Consider removing the pricing table to prevent duplication.This pricing table duplicates information maintained in the UI at envio.dev/pricing. Maintaining pricing details in multiple locations increases the risk of inconsistencies and outdated information.
Consider replacing the detailed table with a brief summary and directing users to the official pricing page, which is already referenced in the info blocks at lines 18-20 and 66-68.
Based on past review comments.
sidebarsHyperIndex.js (1)
80-87: Remove extra blank line for consistency.There's an extra blank line at line 86 after the
self-hostingentry. For consistency with other sections in the sidebar configuration, this blank line can be removed."Hosted_Service/hosted-service-features", "Hosted_Service/hosted-service-deployment", "Hosted_Service/hosted-service-monitoring", "Hosted_Service/hosted-service-billing", "Hosted_Service/self-hosting", - ],
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (14)
docs/HyperIndex-Hosted-LLM/hosted-service-complete.mdx(1 hunks)docs/HyperIndex/Hosted_Service/hosted-service-billing.mdx(2 hunks)docs/HyperIndex/Hosted_Service/hosted-service-deployment.md(1 hunks)docs/HyperIndex/Hosted_Service/hosted-service-features.md(1 hunks)docs/HyperIndex/Hosted_Service/hosted-service-monitoring.md(1 hunks)docs/HyperIndex/Hosted_Service/hosted-service.md(1 hunks)docs/HyperIndex/Hosted_Service/self-hosting.md(1 hunks)docs/HyperRPC/hyperrpc-supported-networks.md(0 hunks)docs/HyperSync/hypersync-supported-networks.md(0 hunks)docusaurus.config.js(1 hunks)sidebarsHyperIndex.js(1 hunks)sidebarsHyperIndexHostedLLM.js(1 hunks)src/pages/index.js(2 hunks)supported-networks.json(1 hunks)
💤 Files with no reviewable changes (2)
- docs/HyperRPC/hyperrpc-supported-networks.md
- docs/HyperSync/hypersync-supported-networks.md
✅ Files skipped from review due to trivial changes (3)
- docs/HyperIndex/Hosted_Service/hosted-service-features.md
- supported-networks.json
- sidebarsHyperIndexHostedLLM.js
🚧 Files skipped from review as they are similar to previous changes (3)
- docs/HyperIndex/Hosted_Service/hosted-service-monitoring.md
- src/pages/index.js
- docs/HyperIndex-Hosted-LLM/hosted-service-complete.mdx
🔇 Additional comments (2)
docusaurus.config.js (1)
278-280: LGTM!The reformatting of the themeConfig header improves readability and maintains proper JSDoc type annotation formatting.
docs/HyperIndex/Hosted_Service/hosted-service-billing.mdx (1)
30-32: Add 30-day deployment limit to development tier disclaimer.The disclaimer should explicitly mention that development deployments are automatically deleted after 30 days, as this is a key limitation that affects production usage decisions.
:::warning Development Tier Disclaimer -The free development tier is intended for testing and development purposes only and should not be used as a production environment. Envio makes no guarantees regarding uptime, availability, or data persistence for deployments on the development tier. If you choose to use a development tier deployment in a production capacity, you do so entirely at your own risk. Envio assumes no liability or accountability for any downtime, data loss, or service interruptions that may occur on development tier deployments. +The free development tier is intended for testing and development purposes only and should not be used as a production environment. Development tier deployments are automatically deleted after 30 days. Envio makes no guarantees regarding uptime, availability, or data persistence for deployments on the development tier. If you choose to use a development tier deployment in a production capacity, you do so entirely at your own risk. Envio assumes no liability or accountability for any downtime, data loss, or service interruptions that may occur on development tier deployments. :::Based on past review comments.
| stylesheets: [ | ||
| { | ||
| href: "/custom.css", | ||
| type: "text/css", | ||
| }, | ||
| ], |
There was a problem hiding this comment.
Remove duplicate stylesheets configuration in themeConfig.
This top-level stylesheets configuration is correct, but the same configuration exists inside themeConfig at lines 297-302. Having duplicate stylesheet declarations is redundant and could cause confusion.
Apply this diff to remove the duplicate configuration from themeConfig:
},
- // Add custom CSS for smaller sidebar text
- stylesheets: [
- {
- href: "/custom.css",
- type: "text/css",
- },
- ],
navbar: {📝 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.
| stylesheets: [ | |
| { | |
| href: "/custom.css", | |
| type: "text/css", | |
| }, | |
| ], | |
| }, | |
| navbar: { |
🤖 Prompt for AI Agents
In docusaurus.config.js around lines 271-276 and 297-302, there's a duplicate
stylesheets block: keep the top-level stylesheets array (lines ~271-276) and
remove the redundant stylesheets declaration inside themeConfig (lines
~297-302); after removal, ensure themeConfig has no leftover empty properties
and that only the top-level stylesheets entry referencing "/custom.css" remains.
| - **Fully Managed Hosted Service**: Let Envio handle everything. The following sections of this page outline the Fully Managed Hosted Service in more detail. This is the recommend deployment method for most users and removes the hosting overhead for your team. See below for the all the awesome features we provide and see the Pricing & Billing page for more information on which Hosting tier suits your indexing needs. | ||
|
|
There was a problem hiding this comment.
Tighten wording in the managed-service bullet.
Please fix the grammar here: “recommend” → “recommended” and drop the extra “the” in “the all the awesome features”.
🤖 Prompt for AI Agents
In docs/HyperIndex-Hosted-LLM/hosted-service-complete.mdx around lines 26–27,
fix the grammar in the managed-service bullet: change “recommend” to
“recommended” and remove the duplicate “the” so the phrase reads “See below for
all the awesome features we provide…”; update the sentence accordingly to
maintain punctuation and flow.
|
|
||
| - **Fully Managed Hosted Service**: Let Envio handle everything. The following sections of this page outline the Fully Managed Hosted Service in more detail. This is the recommend deployment method for most users and removes the hosting overhead for your team. See below for the all the awesome features we provide and see the Pricing & Billing page for more information on which Hosting tier suits your indexing needs. | ||
|
|
||
| - **Self-Hosting**: Run your indexer on your own infrastructure. This requires advanced setup and infrastructure knowledged not unique to Envio. See the repository at https://github.com/enviodev/local-docker-example for a simple docker example to get you started. Please note this example does not cover all infrastructure related needs. It is recommended that at least a separate Postgres management tool is used for self hosting in production. |
There was a problem hiding this comment.
Fix spelling: “knowledged” → “knowledge”.
This typo slipped back in and should read “infrastructure knowledge”.
🤖 Prompt for AI Agents
In docs/HyperIndex-Hosted-LLM/hosted-service-complete.mdx around line 28, fix
the typo "knowledged" to "knowledge" in the Self-Hosting paragraph so the
sentence reads "...requires advanced setup and infrastructure knowledge not
unique to Envio."
32b4ef4 to
0887cb8
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (3)
docs/HyperIndex/Hosted_Service/hosted-service-deployment.md (3)
172-199: Visual steps still misaligned with written steps.The visual guide continues to label “Step 1” as “Select Organization,” while the written flow’s Step 1 is the GitHub login. Every subsequent screenshot is therefore off by one. Please either insert a visual for the GitHub login as Step 1 or renumber all visual headings/captions to match the written sequence.
175-176: Correct GitHub branding in the Step 2 heading.Please capitalize “GitHub” properly in the Step 2 visual heading.
-### Step 2: Install Github App +### Step 2: Install GitHub App
34-51: Fix heading markup so sections render correctly.The
Automatic Deletion RulesandTwo-Stage Deletion Processheadings still have stray**markers and a missing space after the hash marks, so they don’t render as headings. Please clean up the markup.-#### Automatic Deletion Rules:** +#### Automatic Deletion Rules ... -####Two-Stage Deletion Process:** +#### Two-Stage Deletion Process
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/HyperIndex/Hosted_Service/hosted-service-deployment.md(1 hunks)docs/HyperIndex/Hosted_Service/hosted-service.md(1 hunks)
| - **Fully Managed Hosted Service**: Let Envio handle everything. The following sections of this page outline the Fully Managed Hosted Service in more detail. This is the recommend deployment method for most users and removes the hosting overhead for your team. See below for the all the awesome features we provide and see the [Pricing & Billing](./hosted-service-billing.mdx) page for more information on which Hosting tier suits your indexing needs. | ||
|
|
||
| - **Self-Hosting**: Run your indexer on your own infrastructure. This requires advanced setup and infrastructure knowledge not unique to Envio. See the following [repository](https://github.com/enviodev/local-docker-example) for a simple docker example to get you started. Please note this example does not cover all infrastructure related needs. It is recommended that at least a separate Postgres management tool is used for self hosting in production. For further instructions see the [Self Hosting Guide](self-hosting) | ||
|
|
There was a problem hiding this comment.
Tighten grammar and naming in deployment option copy.
Please fix the small wording issues in this bullet so it reads smoothly and matches our terminology.
-- **Fully Managed Hosted Service**: Let Envio handle everything. The following sections of this page outline the Fully Managed Hosted Service in more detail. This is the recommend deployment method for most users and removes the hosting overhead for your team. See below for the all the awesome features we provide and see the [Pricing & Billing](./hosted-service-billing.mdx) page for more information on which Hosting tier suits your indexing needs.
+- **Fully Managed Hosted Service**: Let Envio handle everything. The following sections of this page outline the Fully Managed Hosted Service in more detail. This is the recommended deployment method for most users and removes the hosting overhead for your team. See below for all the awesome features we provide and review the [Pricing & Billing](./hosted-service-billing.mdx) page for more information on which hosting tier suits your indexing needs.
...
-- **Self-Hosting**: Run your indexer on your own infrastructure. This requires advanced setup and infrastructure knowledge not unique to Envio. See the following [repository](https://github.com/enviodev/local-docker-example) for a simple docker example to get you started. Please note this example does not cover all infrastructure related needs. It is recommended that at least a separate Postgres management tool is used for self hosting in production. For further instructions see the [Self Hosting Guide](self-hosting)
+- **Self-Hosting**: Run your indexer on your own infrastructure. This requires advanced setup and infrastructure knowledge not unique to Envio. See the following [repository](https://github.com/enviodev/local-docker-example) for a simple docker example to get you started. Please note this example does not cover all infrastructure-related needs. It is recommended that at least a separate Postgres management tool is used for self-hosting in production. For further instructions see the [Self-Hosting Guide](self-hosting).📝 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.
| - **Fully Managed Hosted Service**: Let Envio handle everything. The following sections of this page outline the Fully Managed Hosted Service in more detail. This is the recommend deployment method for most users and removes the hosting overhead for your team. See below for the all the awesome features we provide and see the [Pricing & Billing](./hosted-service-billing.mdx) page for more information on which Hosting tier suits your indexing needs. | |
| - **Self-Hosting**: Run your indexer on your own infrastructure. This requires advanced setup and infrastructure knowledge not unique to Envio. See the following [repository](https://github.com/enviodev/local-docker-example) for a simple docker example to get you started. Please note this example does not cover all infrastructure related needs. It is recommended that at least a separate Postgres management tool is used for self hosting in production. For further instructions see the [Self Hosting Guide](self-hosting) | |
| - **Fully Managed Hosted Service**: Let Envio handle everything. The following sections of this page outline the Fully Managed Hosted Service in more detail. This is the recommended deployment method for most users and removes the hosting overhead for your team. See below for all the awesome features we provide and review the [Pricing & Billing](./hosted-service-billing.mdx) page for more information on which hosting tier suits your indexing needs. | |
| - **Self-Hosting**: Run your indexer on your own infrastructure. This requires advanced setup and infrastructure knowledge not unique to Envio. See the following [repository](https://github.com/enviodev/local-docker-example) for a simple docker example to get you started. Please note this example does not cover all infrastructure-related needs. It is recommended that at least a separate Postgres management tool is used for self-hosting in production. For further instructions see the [Self-Hosting Guide](self-hosting). |
🤖 Prompt for AI Agents
In docs/HyperIndex/Hosted_Service/hosted-service.md around lines 19 to 22,
tighten grammar and naming: change "This is the recommend deployment method" to
"This is the recommended deployment method", remove the redundant "See below for
the all the awesome features we provide" fragment and instead say "See the
[Pricing & Billing](./hosted-service-billing.mdx) page for details on tiers and
pricing", make "Self-Hosting" consistently styled as "Self-hosting" (or follow
site-wide capitalization) and simplify the second bullet to read that users can
run the indexer on their own infrastructure, reference the example repo as a
simple Docker starting point (not covering production needs), recommend using a
separate Postgres management tool for production, and ensure the Self Hosting
Guide link is formatted and labeled consistently as "See the [Self Hosting
Guide](self-hosting)".
| ## Self-Hosting Option | ||
|
|
||
| For users who prefer to manage their own infrastructure, we support self-hosting your indexer as well. For your convenience, there is a Docker file in the root of the `generated` folder. | ||
| **Available Tiers:** |
There was a problem hiding this comment.
Note. We renamed tiers to plans in the hosted service at some point. Although, I assume now it became a mix of both 😅
There was a problem hiding this comment.
lol you right :) We should stick with Plans.
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (2)
docs/HyperIndex/Hosted_Service/hosted-service-deployment.md (2)
43-51: Promote bold callouts to real headings for lint/accessibility.Replace emphasis-as-heading lines with proper headings to satisfy MD036 and improve structure. This was raised before.
-**When soft limits are breached, the two-stage deletion process begins** - -**Two-Stage Deletion Process:** +When soft limits are breached, the two-stage deletion process begins: + +#### Two-Stage Deletion Process
172-177: Align visual step numbering and fix “GitHub” capitalization.Visual steps start at “Select Organization” while text Step 1 is “Log in with GitHub.” Add a login screenshot as Step 1 or renumber visuals so both sequences match. Also fix “Github” → “GitHub.” Previously flagged.
-### Step 2: Install Github App +### Step 2: Install GitHub App
🧹 Nitpick comments (6)
docs/HyperIndex/Hosted_Service/hosted-service-features.md (1)
74-76: Tighten copy: hyphenation and branding.
- “cross region” → “cross-region”
- “discord” → “Discord”
- Full support for cross region deployments is in active development. If you require a deployment to be based in the USA please contact us through our support channel on discord. + Full support for cross-region deployments is in active development. If you require a deployment to be based in the USA, please contact us through our support channel on Discord.docs/HyperIndex/Hosted_Service/hosted-service-billing.mdx (1)
34-36: Align link style with other docs (optional).For consistency with other pages using relative paths, consider linking Features via the file path.
-For detailed feature explanations, see our [Features page](hosted-service-features). For deployment instructions, see our [Deployment Guide](./hosted-service-deployment.md). Not sure which option is right for your project? [Book a call with our team](https://cal.com/jonjon-clark/15min) to discuss your specific needs. +For detailed feature explanations, see our [Features page](./hosted-service-features.md). For deployment instructions, see our [Deployment Guide](./hosted-service-deployment.md). Not sure which option is right for your project? [Book a call with our team](https://cal.com/jonjon-clark/15min) to discuss your specific needs.docs/HyperIndex/Hosted_Service/hosted-service.md (1)
19-22: Polish copy, fix grammar, and standardize naming.Improves readability, fixes “the all the,” hyphenation, and link text.
- - **Fully Managed Hosted Service**: Let Envio handle everything. The following sections of this page outline the Fully Managed Hosted Service in more detail. This is the recommended deployment method for most users and removes the hosting overhead for your team. See below for the all the awesome features we provide and see the [Pricing & Billing](./hosted-service-billing.mdx) page for more information on which Hosting plan suits your indexing needs. + - **Fully Managed Hosted Service**: Let Envio handle everything. The following sections outline the Hosted Service in more detail. This is the recommended deployment method for most users and removes the hosting overhead for your team. Review the [Pricing & Billing](./hosted-service-billing.mdx) page to choose the hosting plan that best fits your indexing needs. - - **Self-Hosting**: Run your indexer on your own infrastructure. This requires advanced setup and infrastructure knowledge not unique to Envio. See the following [repository](https://github.com/enviodev/local-docker-example) for a simple docker example to get you started. Please note this example does not cover all infrastructure related needs. It is recommended that at least a separate Postgres management tool is used for self-hosting in production. For further instructions see the [Self Hosting Guide](self-hosting) + - **Self-Hosting**: Run your indexer on your own infrastructure. This requires advanced setup and infrastructure knowledge not unique to Envio. See this [example repository](https://github.com/enviodev/local-docker-example) for a simple Docker starting point. Please note it does not cover all infrastructure-related needs. We recommend using a separate Postgres management tool for production. For further instructions, see the [Self-Hosting Guide](self-hosting).docs/HyperIndex/Hosted_Service/hosted-service-monitoring.md (1)
44-46: Fix wording in logging intro sentence.“Smoother grammar.”
-_Full logging supported is integrated and configured by Envio via the Hosted Service_ +_Full logging support is integrated and configured by Envio via the Hosted Service._docs/HyperIndex/Hosted_Service/hosted-service-deployment.md (2)
16-23: Minor consistency: code-format tool and file names; tighten phrasing.Wrap tool/version/file names in code ticks; small clarity tweaks.
-- **PNPM Support**: deployment must be compatible with pnpm version `9.10.0` -- **Package.json**: the `package.json` file must be present and include the above two requirements. +- **PNPM Support**: Deployment must be compatible with `pnpm` version `9.10.0`. +- **package.json**: A `package.json` must be present and include the above two requirements.
39-42: Consistency nit in bullets (capitalization/punctuation).Capitalize first words in list items for uniform style.
- - 5GB storage used - - no requests for 7 days + - 5GB storage used + - No requests for 7 days
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
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-features.md(1 hunks)docs/HyperIndex/Hosted_Service/hosted-service-monitoring.md(1 hunks)docs/HyperIndex/Hosted_Service/hosted-service.md(1 hunks)
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (1)
docs/HyperIndex/Hosted_Service/hosted-service-deployment.md (1)
172-196: Align visual-step titles with the written steps (and fix “GitHub”).The visual guide starts at “Step 1: Select Organization,” but the written list’s Step 1 is “Log in with GitHub,” so every screenshot is offset by one step. Please either add/login screenshot or renumber the visuals so they match the written flow. While editing, correct “Install Github App” to “Install GitHub App.”
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/HyperIndex/Hosted_Service/hosted-service-deployment.md(1 hunks)docs/HyperIndex/Hosted_Service/hosted-service-features.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
docs/HyperIndex/Hosted_Service/hosted-service-deployment.md
43-43: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
47-47: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
docs/HyperIndex/Hosted_Service/hosted-service-features.md
79-79: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
95-95: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
107-107: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
| **When soft limits are breached, the two-stage deletion process begins** | ||
|
|
||
| **Two-Stage Deletion Process:** | ||
|
|
||
| _Applies to development deployments that breach the soft limits_ | ||
|
|
||
| 1. **Grace Period (7 days)** - Your indexer continues to function normally, you receive notification about the upcoming deletion | ||
| 2. **Read-Only Access (3 days)** - Indexer stops processing new data, existing data remains accessible for queries | ||
| 3. **Full Deletion** - Indexer and all data are permanently deleted | ||
|
|
There was a problem hiding this comment.
Convert bold pseudo-headings to proper text/headings.
Lines 43–47 still use bold phrases as headings, tripping markdownlint MD036. Promote “When soft limits… ” to a paragraph (or real heading) and make “Two-Stage Deletion Process” an actual heading to clear the lint failure.
As per static analysis hints.
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
43-43: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
47-47: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🤖 Prompt for AI Agents
In docs/HyperIndex/Hosted_Service/hosted-service-deployment.md around lines 43
to 52, change the bold pseudo-headings to proper Markdown: convert the bold line
"When soft limits are breached, the two-stage deletion process begins" into a
normal paragraph (or a real heading like a sentence-level heading), and turn
"**Two-Stage Deletion Process:**" into an actual Markdown heading (e.g., "##
Two-Stage Deletion Process") so the content no longer uses bold for headings and
satisfies markdownlint MD036.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (3)
docs/HyperIndex/Hosted_Service/hosted-service-deployment.md (3)
172-199: Align visual step numbers with the written instructions.The screenshot sequence still starts at “Step 1: Select Organization,” but the written steps begin with logging in, so every image is offset by one. Please add the missing Step 1 visual (login) or renumber the visuals to match the text.
175-175: Use correct “GitHub” capitalization.The heading should read “Install GitHub App” to match the brand name.
Apply this diff:
-### Step 2: Install Github App +### Step 2: Install GitHub App
43-48: Clear remaining MD036 hits in the fair-usage section.The bold and italic standalone lines here are still parsed as headings, so markdownlint keeps failing. Convert them to plain sentences (or true headings) to get the docs pipeline green.
Apply this diff:
-**When soft limits are breached, the two-stage deletion process begins** +When soft limits are breached, the two-stage deletion process begins. @@ -_Applies to development deployments that breach the soft limits_ +This process applies to development deployments that breach the soft limits.As per static analysis hints.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/HyperIndex/Hosted_Service/hosted-service-deployment.md(1 hunks)docs/HyperIndex/Hosted_Service/hosted-service-features.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
docs/HyperIndex/Hosted_Service/hosted-service-deployment.md
43-43: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
47-47: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
docs/HyperIndex/Hosted_Service/hosted-service-features.md
71-71: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
87-87: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
99-99: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
6f19799 to
c993125
Compare
There was a problem hiding this comment.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docusaurus.config.llm.js (1)
77-82: Add missing “showcase” page or routeThe new navbar item points to
/showcasebut there’s no correspondingsrc/pages/showcase.*or plugin route, so the link will 404—create the page (e.g.src/pages/showcase.js/.mdx) or configure the route.
♻️ Duplicate comments (6)
docs/HyperIndex/Hosted_Service/hosted-service-deployment.md (2)
175-175: Correct GitHub capitalization per branding guidelines.GitHub's official branding requires capital "G" and "H".
As per static analysis hints.
Apply this diff:
-### Step 2: Install Github App +### Step 2: Install GitHub App
43-43: Fix MD036 linting violation on deletion process heading.The bold text on a standalone line is being treated as emphasis-used-as-heading. Convert to plain text or a proper heading.
As per static analysis hints.
Apply this diff:
-**When soft limits are breached, the two-stage deletion process begins** +When soft limits are breached, the two-stage deletion process begins:docs/HyperIndex/Hosted_Service/hosted-service-features.md (3)
87-87: Fix MD036 linting violation on availability note.The standalone italic text triggers markdownlint MD036. Convert to plain text to pass linting.
As per static analysis hints.
Apply this diff:
-*Availability: Dedicated plans only* +Availability: Dedicated plans only.
99-99: Fix MD036 linting violation on availability note.The standalone italic text triggers markdownlint MD036. Convert to plain text to pass linting.
As per static analysis hints.
Apply this diff:
-*Availability: Dedicated plans only (additional cost)* +Availability: Dedicated plans only (additional cost).
71-71: Fix MD036 linting violation on availability note.The standalone italic text triggers markdownlint MD036. Convert to plain text to pass linting.
As per static analysis hints.
Apply this diff:
-*Availability: Dedicated plans only* +Availability: Dedicated plans only.docs/HyperIndex/Hosted_Service/hosted-service.md (1)
19-19: Fix grammatical error in deployment options.Remove the redundant article "the" before "all".
As per static analysis hints.
Apply this diff:
-- **Fully Managed Hosted Service**: Let Envio handle everything. The following sections of this page outline the Fully Managed Hosted Service in more detail. This is the recommended deployment method for most users and removes the hosting overhead for your team. See below for the all the awesome features we provide and see the [Pricing & Billing](./hosted-service-billing.mdx) page for more information on which Hosting plan suits your indexing needs. +- **Fully Managed Hosted Service**: Let Envio handle everything. The following sections of this page outline the Fully Managed Hosted Service in more detail. This is the recommended deployment method for most users and removes the hosting overhead for your team. See below for all the awesome features we provide and see the [Pricing & Billing](./hosted-service-billing.mdx) page for more information on which Hosting plan suits your indexing needs.
🧹 Nitpick comments (2)
docs/HyperIndex/Hosted_Service/self-hosting.md (1)
27-29: Consider hyphenating compound modifiers for clarity.The phrase "production level solution" appears twice and should be hyphenated as "production-level solution" when used as a compound modifier before a noun.
Apply this diff:
:::warning Disclaimer -Self Hosting can be done with a variety of different infrastructure, tools and methods. The outline below is merely a starting point and does not offer a full production level solution. In some cases advanced knowledge of infrastructure, database management and networking may be required for a full production level solution. +Self Hosting can be done with a variety of different infrastructure, tools and methods. The outline below is merely a starting point and does not offer a full production-level solution. In some cases advanced knowledge of infrastructure, database management and networking may be required for a full production-level solution. :::docs/HyperIndex/Hosted_Service/hosted-service.md (1)
21-21: Hyphenate compound modifier for consistency.The phrase "infrastructure related needs" should be hyphenated as "infrastructure-related needs" when used as a compound modifier.
As per static analysis hints.
Apply this diff:
-- **Self-Hosting**: Run your indexer on your own infrastructure. This requires advanced setup and infrastructure knowledge not unique to Envio. See the following [repository](https://github.com/enviodev/local-docker-example) for a simple docker example to get you started. Please note this example does not cover all infrastructure related needs. It is recommended that at least a separate Postgres management tool is used for self-hosting in production. For further instructions see the [Self Hosting Guide](self-hosting) +- **Self-Hosting**: Run your indexer on your own infrastructure. This requires advanced setup and infrastructure knowledge not unique to Envio. See the following [repository](https://github.com/enviodev/local-docker-example) for a simple docker example to get you started. Please note this example does not cover all infrastructure-related needs. It is recommended that at least a separate Postgres management tool is used for self-hosting in production. For further instructions see the [Self Hosting Guide](self-hosting)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (15)
docs/HyperIndex-LLM/hyperindex-complete.mdx(32 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-features.md(1 hunks)docs/HyperIndex/Hosted_Service/hosted-service-monitoring.md(1 hunks)docs/HyperIndex/Hosted_Service/hosted-service.md(1 hunks)docs/HyperIndex/Hosted_Service/self-hosting.md(1 hunks)docs/HyperRPC-LLM/hyperrpc-complete.mdx(2 hunks)docs/HyperSync-LLM/hypersync-complete.mdx(2 hunks)docusaurus.config.js(1 hunks)docusaurus.config.llm.js(1 hunks)sidebarsHyperIndex.js(1 hunks)sidebarsHyperIndexHosted.js(1 hunks)src/pages/index.js(2 hunks)supported-networks.json(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (4)
- sidebarsHyperIndex.js
- docusaurus.config.js
- supported-networks.json
- src/pages/index.js
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-07-29T14:30:03.677Z
Learnt from: DenhamPreen
PR: enviodev/docs#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/HyperSync-LLM/hypersync-complete.mdxdocs/HyperRPC-LLM/hyperrpc-complete.mdx
🪛 LanguageTool
docs/HyperIndex/Hosted_Service/hosted-service-billing.mdx
[grammar] ~23-~23: There might be a mistake here.
Context: ...o.dev/pricing). ::: Available Plans: - Development - Free plan perfect for te...
(QB_NEW_EN)
[grammar] ~24-~24: There might be a mistake here.
Context: ...plan perfect for testing and development - Production Small - Paid plan to get st...
(QB_NEW_EN)
[grammar] ~25-~25: There might be a mistake here.
Context: ... get started with production deployments - Production Medium - Paid plan for scal...
(QB_NEW_EN)
[grammar] ~26-~26: There might be a mistake here.
Context: ...lan for scaling your indexing operations - Production Large - Paid plan for high-...
(QB_NEW_EN)
[grammar] ~27-~27: There might be a mistake here.
Context: ...lan for high-volume production workloads - Dedicated - Custom pricing for ultimat...
(QB_NEW_EN)
docs/HyperIndex/Hosted_Service/hosted-service.md
[style] ~19-~19: Consider using a more formal and expressive alternative to ‘awesome’.
Context: ...or your team. See below for the all the awesome features we provide and see the [Pricin...
(AWESOME)
[grammar] ~21-~21: Use a hyphen to join words.
Context: ...xample does not cover all infrastructure related needs. It is recommended that at...
(QB_NEW_EN_HYPHEN)
[grammar] ~58-~58: There might be a mistake here.
Context: ...exer on your own infrastructure :::info It is recommended that before deploying ...
(QB_NEW_EN)
[grammar] ~59-~59: There might be a mistake here.
Context: ... it runs smoothly on the Hosted Service. For a complete list of local CLI command...
(QB_NEW_EN)
docs/HyperIndex/Hosted_Service/hosted-service-deployment.md
[grammar] ~20-~20: There might be a mistake here.
Context: ... and include the above two requirements. - Configuration file: a HyperIndex confi...
(QB_NEW_EN)
[grammar] ~26-~26: There might be a mistake here.
Context: ...its and policies: ### Deployment Limits - 3 development plan indexers per organi...
(QB_NEW_EN)
[grammar] ~27-~27: There might be a mistake here.
Context: ...lopment plan indexers** per organization - Deployments per indexer: 3 deployment...
(QB_NEW_EN)
[grammar] ~28-~28: There might be a mistake here.
Context: ...er indexer**: 3 deployments per indexer - Deployments can be deleted in the hosted...
(QB_NEW_EN)
[grammar] ~31-~31: There might be a mistake here.
Context: ... ### Development Plan Fair Usage Policy The free development plan includes autom...
(QB_NEW_EN)
[grammar] ~34-~34: There might be a mistake here.
Context: ...ocation: #### Automatic Deletion Rules: - Hard Limits: - Deployments that exc...
(QB_NEW_EN)
[grammar] ~35-~35: There might be a mistake here.
Context: ...matic Deletion Rules: - Hard Limits: - Deployments that exceed 20GB of storage ...
(QB_NEW_EN)
[grammar] ~38-~38: There might be a mistake here.
Context: ...Soft Limits (whichever comes first): - 100,000 events processed - 5GB storage...
(QB_NEW_EN)
[grammar] ~73-~73: There might be a mistake here.
Context: ...de 6. Configure Deployment Settings: - Specify the config file location - Se...
(QB_NEW_EN)
[grammar] ~94-~94: There might be a mistake here.
Context: ...on Management**: Once deployed, you can: - View detailed logs - Switch between ...
(QB_NEW_EN)
[uncategorized] ~175-~175: The official name of this software platform is spelled with a capital “H”.
Context: ...e/select-org.webp) ### Step 2: Install Github App 
[grammar] ~194-~194: There might be a mistake here.
Context: ...rvice/push.webp) ### Step 8: Monitoring Full details are available in our **[Mon...
(QB_NEW_EN)
docs/HyperIndex/Hosted_Service/hosted-service-features.md
[grammar] ~23-~23: There might be a mistake here.
Context: ...nts can query your indexer. Benefits: - Enhanced security for sensitive data - P...
(QB_NEW_EN)
[grammar] ~24-~24: There might be a mistake here.
Context: ...* - Enhanced security for sensitive data - Prevent unauthorized access - Control AP...
(QB_NEW_EN)
[grammar] ~25-~25: There might be a mistake here.
Context: ...itive data - Prevent unauthorized access - Control API usage from specific sources ...
(QB_NEW_EN)
[grammar] ~26-~26: There might be a mistake here.
Context: ... Control API usage from specific sources - Ideal for production environments with s...
(QB_NEW_EN)
[grammar] ~42-~42: There might be a mistake here.
Context: ...channels to receive alerts: - Discord - Slack - Telegram - Email ##...
(QB_NEW_EN)
[grammar] ~43-~43: There might be a mistake here.
Context: ...eceive alerts: - Discord - Slack - Telegram - Email ## Zero-Downti...
(QB_NEW_EN)
[grammar] ~44-~44: There might be a mistake here.
Context: ... - Discord - Slack - Telegram - Email ## Zero-Downtime Deployments ...
(QB_NEW_EN)
[grammar] ~51-~51: There might be a mistake here.
Context: ...c production endpoints. How it works: - Deploy new versions alongside your curre...
(QB_NEW_EN)
[grammar] ~58-~58: There might be a mistake here.
Context: ...dpoint changes required Key Features: - Static Production Endpoint: Consistent...
(QB_NEW_EN)
[grammar] ~59-~59: There might be a mistake here.
Context: ...regardless of which deployment is active - Instant Switching: Promote any deploym...
(QB_NEW_EN)
[grammar] ~60-~60: There might be a mistake here.
Context: ...loyment to production with zero downtime - Rollback Capabilities: Quickly switch ...
(QB_NEW_EN)
[grammar] ~61-~61: There might be a mistake here.
Context: ...h back to previous deployments if needed - Seamless Updates: Your applications co...
(QB_NEW_EN)
[grammar] ~68-~68: There might be a mistake here.
Context: ... through our support channel on discord. ::: *Availability: Dedicated plans only...
(QB_NEW_EN)
[grammar] ~75-~75: There might be a mistake here.
Context: ...ance requirements. Available Regions: - USA - EU Benefits: - Reduce...
(QB_NEW_EN)
[grammar] ~76-~76: There might be a mistake here.
Context: ...rements. Available Regions: - USA - EU Benefits: - Reduced latency f...
(QB_NEW_EN)
[grammar] ~79-~79: There might be a mistake here.
Context: ...ons:** - USA - EU Benefits: - Reduced latency for your target users - ...
(QB_NEW_EN)
[grammar] ~80-~80: There might be a mistake here.
Context: ... - Reduced latency for your target users - Data residency compliance support - Cust...
(QB_NEW_EN)
[grammar] ~81-~81: There might be a mistake here.
Context: ...sers - Data residency compliance support - Custom infrastructure configurations - D...
(QB_NEW_EN)
[grammar] ~82-~82: There might be a mistake here.
Context: ...t - Custom infrastructure configurations - Dedicated infrastructure resources ## D...
(QB_NEW_EN)
[grammar] ~91-~91: There might be a mistake here.
Context: ...standard GraphQL endpoint. Use Cases: - Complex analytical queries - Custom data...
(QB_NEW_EN)
[grammar] ~92-~92: There might be a mistake here.
Context: ...se Cases:** - Complex analytical queries - Custom data exports - Advanced reporting...
(QB_NEW_EN)
[grammar] ~93-~93: There might be a mistake here.
Context: ...analytical queries - Custom data exports - Advanced reporting and dashboards - Inte...
(QB_NEW_EN)
[grammar] ~94-~94: There might be a mistake here.
Context: ...orts - Advanced reporting and dashboards - Integration with external analytics tool...
(QB_NEW_EN)
[grammar] ~103-~103: There might be a mistake here.
Context: ...ase instance. Technical Architecture: - Data Pipeline: Automatic replication f...
(QB_NEW_EN)
[grammar] ~104-~104: There might be a mistake here.
Context: ...eplication from PostgreSQL to ClickHouse - Near Real-time: Data available in an a...
(QB_NEW_EN)
[grammar] ~105-~105: There might be a mistake here.
Context: ... an analytics platform within ~2 minutes - Frontend: Hosted Metabase instance for...
(QB_NEW_EN)
[grammar] ~106-~106: There might be a mistake here.
Context: ... instance for visualization and analysis - Performance: ClickHouse optimized for ...
(QB_NEW_EN)
[grammar] ~109-~109: There might be a mistake here.
Context: ...eries on large datasets Capabilities: - Interactive, customizable dashboards thr...
(QB_NEW_EN)
[grammar] ~110-~110: There might be a mistake here.
Context: ...customizable dashboards through Metabase - Variety of visualization options (charts...
(QB_NEW_EN)
[grammar] ~111-~111: There might be a mistake here.
Context: ...n options (charts, graphs, tables, maps) - Fast analytical queries on large dataset...
(QB_NEW_EN)
[grammar] ~112-~112: There might be a mistake here.
Context: ...queries on large datasets via ClickHouse - Ad-hoc SQL queries for data exploration ...
(QB_NEW_EN)
[grammar] ~113-~113: There might be a mistake here.
Context: ... Ad-hoc SQL queries for data exploration - Automated alerts based on data threshold...
(QB_NEW_EN)
[grammar] ~114-~114: There might be a mistake here.
Context: ...utomated alerts based on data thresholds - Team collaboration and report sharing - ...
(QB_NEW_EN)
[grammar] ~115-~115: There might be a mistake here.
Context: ... - Team collaboration and report sharing - Export capabilities for further analysis...
(QB_NEW_EN)
docs/HyperIndex/Hosted_Service/hosted-service-monitoring.md
[grammar] ~16-~16: There might be a mistake here.
Context: ...exer's status: Key Metrics Displayed: - Active Deployments: Track how many dep...
(QB_NEW_EN)
[grammar] ~27-~27: There might be a mistake here.
Context: ...ployment shows clear status information: - Syncing: Indexer is actively processin...
(QB_NEW_EN)
[grammar] ~36-~36: There might be a mistake here.
Context: ...oblems. Failure Information Includes: - Error Type: Clear indication of the fa...
(QB_NEW_EN)
[grammar] ~37-~37: There might be a mistake here.
Context: ...e failure (e.g., "Indexing Has Stopped") - Error Description: Details about what ...
(QB_NEW_EN)
[grammar] ~38-~38: There might be a mistake here.
Context: ...ng (e.g., "Error during event handling") - Next Steps: Guidance on where to find ...
(QB_NEW_EN)
[grammar] ~39-~39: There might be a mistake here.
Context: ...re to find more information (error logs) - Support Access: Direct link to Discord...
(QB_NEW_EN)
[grammar] ~84-~84: There might be a mistake here.
Context: ...oyment.md)** - Complete deployment guide - **Features*...
(QB_NEW_EN)
[grammar] ~85-~85: There might be a mistake here.
Context: ...ut all available hosted service features - **[Pricing & Billing](./hosted-service-bill...
(QB_NEW_EN)
docs/HyperIndex/Hosted_Service/self-hosting.md
[style] ~28-~28: Consider using a more concise synonym.
Context: ...isclaimer Self Hosting can be done with a variety of different infrastructure, tools and met...
(A_VARIETY_OF)
[grammar] ~28-~28: Use a hyphen to join words.
Context: ...int and does not offer a full production level solution. In some cases advanced k...
(QB_NEW_EN_HYPHEN)
[grammar] ~28-~28: Use a hyphen to join words.
Context: ...ng may be required for a full production level solution. ::: ## Prerequisites Be...
(QB_NEW_EN_HYPHEN)
[grammar] ~28-~28: There might be a mistake here.
Context: ...ed for a full production level solution. ::: ## Prerequisites Before self-hostin...
(QB_NEW_EN)
[grammar] ~29-~29: There might be a mistake here.
Context: ...or a full production level solution. ::: ## Prerequisites Before self-hosting, ensu...
(QB_NEW_EN)
🪛 markdownlint-cli2 (0.18.1)
docs/HyperIndex/Hosted_Service/hosted-service-deployment.md
43-43: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
47-47: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🔇 Additional comments (4)
sidebarsHyperIndexHosted.js (1)
9-13: Clarify purpose of commented-out link.The commented-out alternative link to HyperSync-LLM documentation lacks context. Either remove it if no longer needed, or add a comment explaining why it's preserved for future reference.
Is this commented code meant to be:
- Removed entirely as part of cleanup?
- Kept as a reference for future migration?
- Activated under certain conditions?
Please clarify the intent so the codebase remains maintainable.
docs/HyperIndex/Hosted_Service/hosted-service-billing.mdx (1)
14-36: LGTM! Clear pricing structure and development plan disclaimer.The updated pricing documentation clearly outlines available plans and includes an important disclaimer about development plan limitations (30-day lifespan, no production guarantees). This helps set proper expectations for users.
docs/HyperIndex/Hosted_Service/hosted-service-monitoring.md (2)
64-64: Anchors confirmed – The#alerts-tabanchor exists in both hosted-service-deployment.md (“#### Alerts Tab”) and hosted-service-features.md (“## Built-in Alerts”).
29-29: Anchor link verified as correct.The section "Development Plan Fair Usage Policy" exists at line 31 in
hosted-service-deployment.mdas a level-3 heading (###), which correctly generates the anchor#development-plan-fair-usage-policyreferenced in the monitoring document. No broken references.
|
|
||
| #### Two-Stage Deletion Process | ||
|
|
||
| _Applies to development deployments that breach the soft limits_ |
There was a problem hiding this comment.
Fix MD036 linting violation on section note.
The italic text on a standalone line triggers markdownlint MD036. Convert to plain text.
As per static analysis hints.
Apply this diff:
-_Applies to development deployments that breach the soft limits_
+Applies to development deployments that breach the soft limits:📝 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.
| _Applies to development deployments that breach the soft limits_ | |
| Applies to development deployments that breach the soft limits: |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
47-47: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🤖 Prompt for AI Agents
In docs/HyperIndex/Hosted_Service/hosted-service-deployment.md around line 47,
the standalone italic line "_Applies to development deployments that breach the
soft limits_" triggers markdownlint rule MD036; replace the standalone
italicized line with plain text (remove the surrounding asterisks/underscores)
or incorporate it into surrounding paragraph text so it is not a single
italicized line, ensuring the content remains the same but no longer formatted
as a standalone emphasis line.
| | Chainweb Testnet 21 | 5921 | https://chainweb-testnet-21.rpc.hypersync.xyz or https://5921.rpc.hypersync.xyz | | | ||
| | Chainweb Testnet 22 | 5922 | https://chainweb-testnet-22.rpc.hypersync.xyz or https://5922.rpc.hypersync.xyz | | |
There was a problem hiding this comment.
Remove Chainweb Testnet 21 (endpoint returns 404).
The Chainweb Testnet 21 HyperRPC endpoint (5921.rpc.hypersync.xyz) still returns HTTP 404, so listing it here gives readers a dead URL. Please drop this row (and ideally Testnet 20 as well while you’re touching the table) until the service is live. Based on learnings
🤖 Prompt for AI Agents
In docs/HyperRPC-LLM/hyperrpc-complete.mdx around lines 181 to 182, the table
includes a dead endpoint for Chainweb Testnet 21 (returns HTTP 404); remove the
entire row for Chainweb Testnet 21 and also remove the row for Chainweb Testnet
20 while editing the table so that no dead URLs remain, then reflow the table
markup so columns align correctly and update any adjacent row numbers or spacing
as needed.
| | Chainweb Testnet 21 | 5921 | https://chainweb-testnet-21.hypersync.xyz or https://5921.hypersync.xyz | 🪨 | | | ||
| | Chainweb Testnet 22 | 5922 | https://chainweb-testnet-22.hypersync.xyz or https://5922.hypersync.xyz | 🪨 | | |
There was a problem hiding this comment.
Drop Chainweb Testnet 21 from the table.
That HyperSync endpoint (https://5921.hypersync.xyz) is still non-functional (HTTP 404), so documenting it will mislead users. Please remove the row (and consider pruning Testnet 20 while you’re here). Based on learnings
🤖 Prompt for AI Agents
In docs/HyperSync-LLM/hypersync-complete.mdx around lines 2046-2047, remove the
entire table row for "Chainweb Testnet 21" (both the label and its URL variants)
so the non-functional https://5921.hypersync.xyz endpoint is no longer
documented; while editing, scan the surrounding table for "Chainweb Testnet 20"
and remove or comment its row if it is also non-functional to keep the table
accurate.
Summary by CodeRabbit
New Features
Documentation
Chores