docs(compute): add KeepAwakeGuard documentation#7960
docs(compute): add KeepAwakeGuard documentation#7960prisma-gremlin[bot] wants to merge 7 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
🍈 Lychee Link Check Report9 links: ✅ All links are working!Full Statistics Table
|
|
The latest updates on your projects. Learn more about Argos notifications ↗︎
|
- Rename the page to "Long-running servers" (searchable by intent) and lead with the use case; KeepAwakeGuard stays documented as the API - Slug/url -> /compute/long-running-servers; reposition in the nav under Features right after Deployments - Make "Next steps" start with "Get started with Prisma Compute" - Remove em dashes, tighten for coherence (add a "When to use it" section) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
WalkthroughA new MDX documentation page, ChangesInstance Keep-Awake Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Comment |
"Long-running servers" implied an always-on server. The feature actually keeps an instance awake (prevents scale-to-zero) while work outlives a request, so title/slug/url -> "Keeping instances awake" / /compute/keeping-instances-awake. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
…test The 0.1.0-dev.4.1 version is not user-facing. Reword the rename note to install @prisma/compute@latest and migrate imports to KeepAwakeGuard. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@apps/docs/content/docs/compute/keeping-instances-awake.mdx`:
- Around line 11-15: The documentation introduces KeepAwakeGuard but does not
document ScaleToZeroGuard as its deprecated predecessor. Add a compatibility
note or migration section in the keeping-instances-awake.mdx file that clarifies
that ScaleToZeroGuard has been deprecated and replaced with KeepAwakeGuard,
helping users on older versions of `@prisma/compute` understand the naming change.
This note should be included both where KeepAwakeGuard is first introduced in
the primitives list and in any other relevant sections (around lines 128-145)
where KeepAwakeGuard usage is discussed or demonstrated.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: bf1fdb0b-47d2-4508-adbc-61fe4c70f0cc
📒 Files selected for processing (1)
apps/docs/content/docs/compute/keeping-instances-awake.mdx
What changed
Adds a new documentation page for the KeepAwakeGuard feature from
@prisma/computeat/compute/keep-awake-guard.Key details documented
ScaleToZeroGuardin@prisma/compute@0.1.0-dev.4.1. The old name is documented as a deprecated alias.signaloption is a fallback for extreme cases where the platform cannot honor the keep-awake guarantee. It is explicitly not intended as the cancellation signal for underlying work.waitUntil-style patterns from Cloudflare Workers and Service Worker APIs for familiarity.release(),waitUntil, and thesignalfallback.Files changed
apps/docs/content/docs/compute/keep-awake-guard.mdx— new documentation pageapps/docs/content/docs/compute/meta.json— addedkeep-awake-guardto the Features section of the sidebarSummary by CodeRabbit
waitUntil,KeepAwakeGuard, includingrelease()and thesignalfallback option, with examples and links to related documentation.