Update docs for new hosted service cache solution & Deployment tags#770
Update docs for new hosted service cache solution & Deployment tags#770MJYoung114 merged 5 commits intomainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughPre-merge checks✅ Passed checks (3 passed)
📜 Recent review detailsConfiguration used: defaults Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🧰 Additional context used🪛 markdownlint-cli2 (0.18.1)docs/HyperIndex/Hosted_Service/hosted-service-features.md45-45: Emphasis used instead of a heading (MD036, no-emphasis-as-heading) 58-58: Emphasis used instead of a heading (MD036, no-emphasis-as-heading) 90-90: Emphasis used instead of a heading (MD036, no-emphasis-as-heading) 🔇 Additional comments (1)
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 (2)
docs/HyperIndex/Hosted_Service/hosted-service-features.md (1)
19-19: Use proper heading syntax instead of emphasis for "Availability" notes.Markdown linter (MD036) flags that
*Availability: Paid plans only*uses emphasis instead of heading syntax. To align with markdown best practices, convert these to proper headings (e.g.,### Availability).🔎 Proposed fix
- *Availability: Paid plans only* + ### Availability + + Paid plans onlyAlternatively, if you prefer a lighter style without hierarchical headings:
- *Availability: Paid plans only* + **Availability:** Paid plans onlyApply this pattern to lines 19, 32, and 63.
Also applies to: 32-32, 63-63
docs/HyperIndex/Advanced/effect-api.md (1)
55-55: Clarify rateLimit as "required parameter" vs. "can be disabled."Line 55 states
rateLimit (required), but line 184 clarifies you can set it tofalseto disable rate limiting. While technically correct (the field must be present in the options object), the documentation could be clearer. Consider revising line 55 to reflect thatrateLimitis a required field but its value can befalseto disable rate limiting.🔎 Proposed clarification
- `rateLimit` (required) - the maximum calls allowed per timeframe, or `false` to disable + `rateLimit` (required) - set to `false` to disable rate limiting, or define a custom limit (e.g., `{ calls: 5, per: "second" }`)This avoids the apparent contradiction and aligns with the explanation on line 184.
Also applies to: 184-184
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/HyperIndex/Advanced/effect-api.mddocs/HyperIndex/Hosted_Service/hosted-service-features.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
docs/HyperIndex/Hosted_Service/hosted-service-features.md
19-19: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
32-32: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
63-63: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🔇 Additional comments (3)
docs/HyperIndex/Hosted_Service/hosted-service-features.md (1)
30-60: Excellent documentation for Effect API Cache feature.The new Effect API Cache section is well-structured with clear step-by-step workflow, key features, and benefits. The version requirement is explicitly documented, and the cross-reference to effect-api.md documentation is helpful.
docs/HyperIndex/Advanced/effect-api.md (2)
169-180: Well-documented shift to dashboard-based cache management.The "Cache on Hosted Service" section clearly explains the transition from repository-based
.envio/cacheto built-in dashboard management. The cross-reference to the hosted-service-features.md documentation is helpful, and the removal of file size limitations is a valuable improvement note.
212-236: Clear migration guidance for experimental to production API.The migration section provides explicit examples showing the change from
experimental_createEffecttocreateEffectand the addition ofrateLimit. The diff format is easy to follow and aligns with the version requirements documented elsewhere in the file.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/HyperIndex/Hosted_Service/hosted-service-features.md (1)
19-19: Resolve Markdown linting violations for availability notes.The static analysis tool flags lines 19, 32, and 64 as using emphasis (
*...*) where headings may be expected (MD036). While these availability notes are intentionally styled as metadata badges rather than headings, consider either:
- Converting to bold syntax:
**Availability: Paid plans only**- Moving to an
:::infocallout for visual consistency with version requirements- Suppressing the linting rule if this style is intentional
This is a minor formatting issue, but address it to align with your project's Markdown standards.
🔎 Proposed formatting options
Option 1: Convert to bold (minimal change)
-*Availability: Paid plans only* +**Availability: Paid plans only**Option 2: Use info callout (consistent with version requirements)
-*Availability: Paid plans only* +:::info Availability +This feature is only available for paid plans. [View our pricing plans](./hosted-service-billing.mdx). +:::Also applies to: 32-32, 64-64
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/HyperIndex/Hosted_Service/hosted-service-features.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
docs/HyperIndex/Hosted_Service/hosted-service-features.md
19-19: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
32-32: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
64-64: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🔇 Additional comments (2)
docs/HyperIndex/Hosted_Service/hosted-service-features.md (2)
30-60: Excellent addition of Effect API Cache documentation.The new Effect API Cache section is well-structured and comprehensive. The step-by-step workflow (Save → Configure → Enable → Deploy) is clear, and the feature breakdown (Quick Save, Cache Management, Automatic Restore, Download Cache) effectively communicates value. The version requirement (2.26.0+) is properly documented.
58-70: Version numbers are accurate and consistent across related documentation.The version requirements documented (2.26.0 for Effect API Cache, 2.24.0 for Built-in Alerts) are confirmed in
effect-api.mdandhosted-service-deployment.md. Documentation consistently reflects the current API withcreateEffectand requiredrateLimitparameter (introduced in v2.32.0), with proper migration guidance from deprecatedexperimental_createEffect.
Piroddi
changed the title
There was a problem hiding this comment.
Actionable comments posted: 1
Fix all issues with AI Agents 🤖
In @docs/HyperIndex/Hosted_Service/hosted-service-features.md:
- Line 45: Replace the emphasized, heading-like lines that use single asterisks
(the three occurrences reading "Availability: Paid plans only") with proper
semantic markup: either convert them to a heading (for example "###
Availability: Paid plans only") or wrap them in an info/blockquote consistent
with existing blocks (e.g., use an :::info or :::tip block) so they no longer
trigger MD036; update the three occurrences that match the exact phrase to use
the chosen structure and ensure surrounding spacing/newlines follow the other
examples in the document.
🧹 Nitpick comments (1)
docs/HyperIndex/Hosted_Service/hosted-service-features.md (1)
56-86: Verify cross-document consistency with effect-api.md.The Effect API Cache section references
/docs/HyperIndex/effect-apiand the PR summary indicates that file includes related details about Save Cache, Cache Settings, Automatic Restore, andrateLimitoptions. Ensure the guidance, terminology, and examples are aligned across both documents, particularly regarding migration from experimental APIs and rate-limiting considerations.If you'd like, I can help generate a verification script to compare key terminology and concepts across the two documentation files.
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/HyperIndex/Hosted_Service/hosted-service-features.md
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
docs/HyperIndex/Hosted_Service/hosted-service-features.md
45-45: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
58-58: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
90-90: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🔇 Additional comments (2)
docs/HyperIndex/Hosted_Service/hosted-service-features.md (2)
84-96: Clarify version requirement for Built-in Alerts.The enriched summary indicates the version requirement for Alerts was updated to 2.26.0, but line 95 shows 2.24.0. Confirm whether this is intentional or if an update was missed. For consistency, if other features (like Effect API Cache) require 2.26.0+, the Alerts version requirement may need alignment.
17-41: Well-structured addition of Deployment Tags section.The new Deployment Tags section is clear, well-organized, and provides practical examples and use cases. The explanation of the special
nametag behavior is helpful, and the benefits list adds good context for users.
|
|
||
| ## IP Whitelisting | ||
|
|
||
| *Availability: Paid plans only* |
There was a problem hiding this comment.
Fix markdown linting violations: use proper heading structure for availability notices.
The static analysis tool flagged MD036 violations on lines 45, 58, and 90. Emphasis (single asterisks) should not be used as a heading-like statement. Consider formatting these as proper headings (e.g., ### Availability: Paid plans only) or restructuring them as info boxes/blockquotes for better semantics and consistency with the existing :::info and :::tip blocks used elsewhere.
🔎 Suggested formatting options
Option 1: Use proper heading notation:
-*Availability: Paid plans only*
+### Availability: Paid plans onlyOption 2: Use an info block (more consistent with existing style):
-*Availability: Paid plans only*
+:::info Availability
+Paid plans only
+:::Also applies to: 58-58, 90-90
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
45-45: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🤖 Prompt for AI Agents
In @docs/HyperIndex/Hosted_Service/hosted-service-features.md around line 45,
Replace the emphasized, heading-like lines that use single asterisks (the three
occurrences reading "Availability: Paid plans only") with proper semantic
markup: either convert them to a heading (for example "### Availability: Paid
plans only") or wrap them in an info/blockquote consistent with existing blocks
(e.g., use an :::info or :::tip block) so they no longer trigger MD036; update
the three occurrences that match the exact phrase to use the chosen structure
and ensure surrounding spacing/newlines follow the other examples in the
document.
3 participants
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.