Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
|
Caution Review failedThe pull request is closed. WalkthroughDocumentation-only updates: standardized "HyperSync" terminology, revised API token policy/timelines (tokens required from 3 November 2025), clarified local/self-hosted token handling and CLI auto-login, removed the Berachain Bartio network row, and compacted supported-networks JSON formatting. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (2)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
docs/HyperSync-LLM/hypersync-complete.mdx (1)
1907-1907: Clarify the call-to-action regarding HyperSync packages.The phrase "Please take a look at our HyperSync packages so your access remains open" is indirect and vague. Users need clearer guidance on what action to take and when. Consider rewording to be more specific about:
- Which packages are recommended or required
- When users should take action (before mid-November 2025?)
- What happens if they don't take action
Consider revising this to something like:
- HyperSync implements **rate limits for requests without API tokens**. API tokens will be required from **1 November 2025**. The service remains **free to use until mid-November 2025**. Please take a look at our HyperSync packages so your access remains open. Indexers deployed to our hosted service will have special access to HyperSync that does not require a custom API token. + HyperSync implements **rate limits for requests without API tokens**. **API tokens will be required from 1 November 2025**; the service remains **free to use until mid-November 2025**. Review our HyperSync packages and plan your upgrade before mid-November 2025 to ensure uninterrupted access. Note: Indexers deployed to our hosted service receive automatic access without requiring a custom token.docs/HyperSync/api-tokens.mdx (1)
17-17: Strengthen the call-to-action in this reference document.As the primary documentation for API tokens, this section should provide more explicit guidance. The phrase "Please take a look at our HyperSync packages so your access remains open" doesn't clearly tell users what to do or by when.
Revise the messaging to be more actionable. For example:
- HyperSync implements **rate limits for requests without API tokens**. API tokens will be required from **1 November 2025**. The service remains **free to use until mid-November 2025**. Please take a look at our HyperSync packages so your access remains open. Indexers deployed to our hosted service will have special access to HyperSync that does not require a custom API token. + HyperSync implements **rate limits for requests without API tokens**. **API tokens are required from 1 November 2025**; the service is free until mid-November 2025. Choose a HyperSync package before mid-November 2025 to maintain access. (Link to packages.) Note: Indexers on our hosted service have automatic access without a custom token.This makes the deadline, action, and consequence clearer for users.
docs/HyperIndex-LLM/hyperindex-complete.mdx (1)
657-668: Remove the duplicated AI/LLM info block.The “For AI/LLM Systems” admonition and “Hierarchical Interactive Schema Explorer” heading appear twice back-to-back. Please drop the duplicate copy so the section only renders once.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
docs/HyperIndex-LLM/hyperindex-complete.mdx(2 hunks)docs/HyperIndex/overview.md(1 hunks)docs/HyperSync-LLM/hypersync-complete.mdx(1 hunks)docs/HyperSync/api-tokens.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/HyperSync/api-tokens.mdx
[style] ~17-~17: To make your writing clearer, consider a more direct alternative.
Context: ...o use until mid-November 2025**. Please take a look at our HyperSync packages so your ...
(TAKE_A_LOOK)
docs/HyperSync-LLM/hypersync-complete.mdx
[style] ~1907-~1907: To make your writing clearer, consider a more direct alternative.
Context: ...o use until mid-November 2025**. Please take a look at our HyperSync packages so your ...
(TAKE_A_LOOK)
🔇 Additional comments (2)
docs/HyperIndex/overview.md (2)
52-62: Well-structured API token requirements section.This section clearly communicates the token requirements across different deployment scenarios (local development, self-hosted, hosted service). The updated dates (1 November 2025 for requirement, mid-November 2025 for end of free usage) are consistent with other documentation, and the mention of the "automatic CLI login feature" provides good UX transparency.
The three-tiered structure effectively addresses different user needs:
- Local dev with auto-login support
- Self-hosted with environment variable configuration
- Hosted service with automatic access
52-60: Cross-file consistency verified.The API token policy messaging is consistent across all three files regarding dates (1 November 2025 for requirement, mid-November 2025 for free usage end) and key information about hosted service exceptions. However, note that docs/HyperSync-LLM/hypersync-complete.mdx and docs/HyperSync/api-tokens.mdx use identical messaging with the vague "Please take a look at our HyperSync packages" phrasing that could be clarified (see separate comments on those files).
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
yarn.lockis excluded by!**/yarn.lock,!**/*.lock
📒 Files selected for processing (8)
docs/HyperIndex-LLM/hyperindex-complete.mdx(3 hunks)docs/HyperIndex/overview.md(1 hunks)docs/HyperRPC-LLM/hyperrpc-complete.mdx(0 hunks)docs/HyperRPC/hyperrpc-supported-networks.md(0 hunks)docs/HyperSync-LLM/hypersync-complete.mdx(2 hunks)docs/HyperSync/api-tokens.mdx(1 hunks)docs/HyperSync/hypersync-supported-networks.md(0 hunks)supported-networks.json(1 hunks)
💤 Files with no reviewable changes (3)
- docs/HyperRPC/hyperrpc-supported-networks.md
- docs/HyperRPC-LLM/hyperrpc-complete.mdx
- docs/HyperSync/hypersync-supported-networks.md
🧰 Additional context used
🪛 LanguageTool
docs/HyperIndex/overview.md
[grammar] ~59-~59: Ensure spelling is correct
Context: ... 2025 onwards, we will introduce tiered packagesfor those self-hosting hyperindex and wishi...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🔇 Additional comments (5)
supported-networks.json (1)
1-5: Formatting consolidation approved.The JSON array is reformatted onto a single line. No semantic changes to the supported networks list.
docs/HyperSync/api-tokens.mdx (1)
15-17: Updated API token policy and messaging.Token requirement date (3 November 2025) and rate-limit clarification are clearly stated. The hosted-indexer exemption note is retained. Changes align with the PR's token messaging objectives.
docs/HyperIndex/overview.md (1)
52-59: Updated token policy and guidance are consistent.Terminology standardized to "HyperSync", token requirement date (3 November 2025) is consistent across docs, and local/self-hosted deployment guidance is clarified. The hosted service exemption is retained.
docs/HyperSync-LLM/hypersync-complete.mdx (2)
1905-1907: API token policy consistent with primary docs.Token requirement date (3 November 2025), rate-limit implementation, and hosted-indexer exemption are consistent with the corresponding section in
docs/HyperSync/api-tokens.mdx.
2075-2075: Verify Plasma network tier upgrade.Line 2075 marks the Plasma network tier as changed (indicated by the
~marker). The AI summary notes a tier elevation. Please confirm this network support upgrade is intentional and reflects current infrastructure allocation.
| - **Free Usage**: The service remains free to use until mid-June 2025. | ||
| - **Future Pricing**: From mid-June 2025 onwards, we will introduce tiered packages based on usage. Credits are calculated based on comprehensive metrics including data bandwidth, disk read operations, and other resource utilization factors. For preferred introductory pricing based on your specific use case, reach out to us on Discord. | ||
| - **Future Pricing**: From mid-November 2025 onwards, we will introduce tiered packagesfor those self-hosting hyperindex and wishing to use hypersync. For preferred introductory pricing based on your specific use case, reach out to us on Discord. | ||
|
|
There was a problem hiding this comment.
Fix spacing and brand capitalization
The bullet reads “packagesfor” without a space, and it refers to “hyperindex”/“hypersync” in lowercase while the rest of the doc uses the branded “HyperIndex” and “HyperSync.” Please add the missing space and restore the proper capitalization for consistency.
🤖 Prompt for AI Agents
In docs/HyperIndex-LLM/hyperindex-complete.mdx around line 47, a bullet contains
the typo "packagesfor" and uses lowercase "hyperindex"/"hypersync"; change
"packagesfor" to "packages for" and update the product names to their branded
capitalizations "HyperIndex" and "HyperSync" so the spacing and branding match
the rest of the document.
There was a problem hiding this comment.
| packages for |
There was a problem hiding this comment.
@JasoonS Thanks! I’ve applied the spacing fix and also normalized the product names to match branding elsewhere in the doc. Proposed replacement:
- - **Future Pricing**: From mid-November 2025 onwards, we will introduce tiered packagesfor those self-hosting hyperindex and wishing to use hypersync. For preferred introductory pricing based on your specific use case, reach out to us on Discord.
+ - **Future Pricing**: From mid-November 2025 onwards, we will introduce tiered packages for those self-hosting HyperIndex and wishing to use HyperSync. For preferred introductory pricing based on your specific use case, reach out to us on Discord.If you prefer to keep this change strictly to spacing only, I can drop the capitalization tweak—just say the word.
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (4)
docusaurus.config.llm.js (1)
49-56: Minor: rel without target has no effect.rel="noopener noreferrer" is only meaningful with target="_blank". Either add target or drop rel for a same‑tab internal link.
docusaurus.config.js (3)
289-295: Announcement consistency across sites.Same id/message as LLM config. If both sites share a domain, closing the banner on one closes it on the other (id-based). Confirm this is desired to avoid user confusion.
Consider centralizing the banner copy (e.g., small JS module) to prevent drift.
349-353: Algolia key flagged by secret scanner—confirm search‑only and restrict.Gitleaks flagged an API key. Algolia search keys are usually safe to commit if:
- It’s a search‑only key (no write privileges).
- It’s scoped to your index/app and optionally referrer‑restricted.
If true, add it to your secret‑scanner allowlist or pull it from env vars to reduce noise. Otherwise, rotate and replace.
Possible hardening:
- Referrer restriction in Algolia dashboard.
- Move to env: ALGOLIA_APP_ID, ALGOLIA_SEARCH_API_KEY (still public at build time).
- Add a gitleaks allowlist rule matching this key format/commented context.
5-231: Add CI validation for redirect integrity (optional best practice).Verification confirms all 62 redirect destinations resolve correctly—no broken redirects currently exist. However, the suggestion to add automated CI validation remains a valuable safeguard as the redirect list grows. Consider implementing a validation script to catch misconfigurations early, such as checking that all "to" paths resolve via Docusaurus' slug system or frontmatter references.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docusaurus.config.js(1 hunks)docusaurus.config.llm.js(1 hunks)
🧰 Additional context used
🧬 Code graph analysis (1)
docusaurus.config.js (2)
docusaurus.config.llm.js (4)
config(6-185)require(1-1)lightCodeTheme(2-2)darkCodeTheme(3-3)plugins/plugin-generate-llms.js (1)
require(5-5)
🪛 Gitleaks (8.28.0)
docusaurus.config.js
[high] 349-349: Detected a Generic API Key, potentially exposing access to various services and sensitive operations.
(generic-api-key)
| stylesheets: [ | ||
| { | ||
| href: "/custom.css", | ||
| type: "text/css", | ||
| }, | ||
| ], | ||
| navbar: { |
There was a problem hiding this comment.
Remove themeConfig.stylesheets (unused).
stylesheets is a top‑level Docusaurus config field; placing it under themeConfig is ignored and can confuse future edits. Keep only the top‑level stylesheets.
Apply:
- stylesheets: [
- {
- href: "/custom.css",
- type: "text/css",
- },
- ],📝 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: { | |
| navbar: { |
🤖 Prompt for AI Agents
In docusaurus.config.js around lines 297 to 303, the stylesheets entry is
defined under themeConfig but stylesheets is a top-level Docusaurus config field
and is ignored there; remove the stylesheets block from themeConfig (lines
297–303) and ensure any custom.css reference is placed under the top-level
stylesheets array instead so there is only one top-level stylesheets definition.
| announcementBar: { | ||
| id: "hypersync-api-tokens-nov-2025", | ||
| content: | ||
| 'HyperSync API tokens required from <strong>3 November 2025</strong>. Ensure you are using one to keep uninterrupted HyperSync access. <a href="/docs/HyperSync/api-tokens" rel="noopener noreferrer">Learn more →</a>', | ||
| backgroundColor: "#fff7e6", | ||
| textColor: "#663c00", | ||
| isCloseable: true, | ||
| }, |
There was a problem hiding this comment.
🧩 Analysis chain
Fix “Learn more” link for LLM site (likely 404).
This LLM config doesn’t mount HyperSync (non‑LLM) docs, yet the banner links to /docs/HyperSync/api-tokens. That route likely doesn’t exist in the LLM build. Point to an LLM page or an external absolute URL that resolves correctly.
Two options:
- If LLM has a section covering tokens: link internally (example):
- '... <a href="/docs/HyperSync/api-tokens" rel="noopener noreferrer">Learn more →</a>',
+ '... <a href="/docs/HyperSync-LLM/hypersync-complete#api-tokens" rel="noopener noreferrer">Learn more →</a>',- If you intend to send users to the main docs: use a fully-qualified URL and consider target="_blank":
- '... <a href="/docs/HyperSync/api-tokens" rel="noopener noreferrer">Learn more →</a>',
+ '... <a href="https://docs.envio.dev/docs/HyperSync/api-tokens" target="_blank" rel="noopener noreferrer">Learn more →</a>',To verify the route isn’t present in the LLM build:
🏁 Script executed:
#!/bin/bash
# Check that LLM config doesn't mount HyperSync (non‑LLM) docs
rg -nP -C2 '@docusaurus/plugin-content-docs' docusaurus.config.llm.js | rg -nP 'id:\s*"HyperSync"\b' || echo "No HyperSync plugin found in LLM config (expected)"
# Confirm the source doc exists only in main docs
fd -a 'api-tokens.mdx' docs | sed 's|^|found: |'Length of output: 106
Now let me check the actual LLM config structure and the hypersync-complete documentation to finalize verification:
Based on my verification, the original review comment is correct and valid. Here's what I found:
- Confirmed: LLM config doesn't mount HyperSync (non-LLM) docs (per script output: "No HyperSync plugin found in LLM config")
- Confirmed: The source doc exists only in main docs at
docs/HyperSync/api-tokens.mdx - Verified: The banner link to
/docs/HyperSync/api-tokenswill indeed be a 404 on the LLM site since that route doesn't exist in the LLM build
The web search also revealed that:
- API tokens provide authenticated access to HyperSync services
- All HyperSync clients require an API token for authentication; see the API Tokens guide for detailed instructions
- The LLM docs contain a file with all HyperSync documentation consolidated for LLM consumption
The LLM site uses a consolidated route (/docs/HyperSync-LLM/hypersync-complete) rather than separate individual routes.
Fix broken "Learn more" link in announcementBar (likely 404 on LLM site).
This LLM config doesn't mount HyperSync (non‑LLM) docs, yet the banner links to /docs/HyperSync/api-tokens. That route doesn't exist in the LLM build.
Update the link to one of these options:
- Link to the LLM-specific consolidated docs:
/docs/HyperSync-LLM/hypersync-complete#api-tokens - Link to the main docs using an absolute URL:
https://docs.envio.dev/docs/HyperSync/api-tokenswithtarget="_blank"
🤖 Prompt for AI Agents
In docusaurus.config.llm.js around lines 49 to 56, the announcementBar "Learn
more" href points to /docs/HyperSync/api-tokens which does not exist in the LLM
site and will 404; update the link to a valid target by replacing the path with
either the LLM consolidated route
/docs/HyperSync-LLM/hypersync-complete#api-tokens or with the absolute main docs
URL https://docs.envio.dev/docs/HyperSync/api-tokens (and if using the absolute
URL add target="_blank" and rel="noopener noreferrer").
2 participants
Summary by CodeRabbit
Documentation
Chores