docs(rivetkit): clean up stale setPreventSleep references in docs and JSDoc

[NathanFlurry]

Description

Please include a summary of the changes and the related issue. Please also include relevant motivation and context.

Type of change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes.

Checklist:

• My code follows the style guidelines of this project
• I have performed a self-review of my code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes

[NathanFlurry]

• chore(kitchen-sink): configurable endpoint #4766 : 3 dependent PRs (#4754 , #4777 , #4778 )
• refactor(rivetkit-core): rename StopReason to ShutdownKind and kill enum fallthroughs #4765
• chore(envoy-client): log command and event payloads #4751
• fix(rivetkit): minor sleep-cleanup follow-ups #4761
• docs(rivetkit): clean up stale setPreventSleep references in docs and JSDoc #4760 👈 (View in Graphite)
• docs(rivetkit): document keepAwake/waitUntil counter-arm race and surface bridge errors #4759
• test(engine): force overdue branch in alarm-during-sleep test with negative offset #4758
• fix(rivetkit-core): return stopping not starting when sleep/destroy called mid-shutdown #4757
• test(rivetkit): remove sleepWithPreventSleep fixture and tests #4756
• test(engine): add regression test for alarm-during-sleep-transition race #4755
• test(rivetkit-core): cover sleep/destroy guards and prevent_sleep no-op #4750
• docs: add keepAwake vs waitUntil table and internal sleep-sequence invariants #4749
• feat(rivetkit): expose c.keepAwake(promise) through native path #4748
• refactor(rivetkit): deprecate setPreventSleep to no-op in TypeScript #4747
• fix(rivetkit-core): enumerate non-drained counters in grace deadline warn log #4746
• fix(rivetkit-core): abort graceful cleanup task when grace deadline elapses #4745
• fix(rivetkit-core): error on sleep/destroy before startup or already-requested #4743
• fix(rivetkit-core): cap SerializeState shutdown timeout at 15s #4742
• refactor(rivetkit-core): remove prevent_sleep field and deprecate set_prevent_sleep to no-op #4741
• fix(api-public): remove orphan import_export actors module #4764
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[claude]

Code Review: docs(rivetkit): clean up stale setPreventSleep references

Overview

Small docs-only cleanup PR (9 additions, 8 deletions) that replaces all stale references to the removed c.setPreventSleep(true) API with the current c.keepAwake(promise) API across JSDoc comments and documentation pages.

Changes Reviewed

• actor/config.ts — Two JSDoc/describe strings updated for the deprecated noSleep option
• workflow/context.ts — JSDoc for waitUntil rewritten
• limits.mdx, versions.mdx — Sleep grace period descriptions updated
• architecture.mdx — Architecture overview bullet updated

Looks Good

• All setPreventSleep references correctly replaced with keepAwake(promise)
• The noSleep deprecation message still correctly points users to keepAwake
• Architecture, limits, and versions docs are now consistent with the actual API

One Item to Verify

waitUntil is no longer marked @deprecated — The old JSDoc on waitUntil in workflow/context.ts carried @deprecated, but the new comment is a regular description with no deprecation tag. If this is intentional (restoring waitUntil as a supported API alongside keepAwake), the change is fine and the new description is accurate. If waitUntil is still meant to be deprecated, the @deprecated tag should be added back to the new comment.

The new description itself is clear and correct either way.

Minor Note

The limits.mdx and versions.mdx sleep grace period rows now list keepAwake inline with onSleep and waitUntil. This matches the old wording that included "waiting for preventSleep to clear after shutdown starts", so the semantic intent appears correct.

---

Overall: Clean, accurate cleanup. Ready to merge once the waitUntil deprecation intent is confirmed.

[github-actions]

Preview packages published to npm

Install with:

npm install rivetkit@pr-4760

All packages published as 0.0.0-pr.4760.baefe0f with tag pr-4760.

Engine binary is shipped via @rivetkit/engine-cli on linux-x64-musl, linux-arm64-musl, darwin-x64, and darwin-arm64. Windows users should use the release installer or set RIVET_ENGINE_BINARY.

Docker images:

docker pull rivetdev/engine:slim-baefe0f
docker pull rivetdev/engine:full-baefe0f

Individual packages

npm install rivetkit@pr-4760
npm install @rivetkit/react@pr-4760
npm install @rivetkit/rivetkit-napi@pr-4760
npm install @rivetkit/workflow-engine@pr-4760