Skip to content

AutoResume Docs#123

Merged
matthewlouisbrockman merged 22 commits intomainfrom
auto-resume-docs
Mar 11, 2026
Merged

AutoResume Docs#123
matthewlouisbrockman merged 22 commits intomainfrom
auto-resume-docs

Conversation

@matthewlouisbrockman
Copy link
Copy Markdown
Contributor

@matthewlouisbrockman matthewlouisbrockman commented Feb 20, 2026

Summary

This update adds a new Sandbox AutoResume guide and surfaces it in the docs navigation.

It also documents the current lifecycle API shape using boolean auto-resume flags:

  • JS/TS: lifecycle.autoResume: true | false
  • Python: lifecycle["auto_resume"] = True | False

Persistence docs are updated from beta APIs to stable APIs. Calls them developer preview for now until figure out the pricing.

  • Use sandbox.pause() instead of betaPause() / beta_pause()
  • Use Sandbox.create(..., lifecycle={...}) instead of Sandbox.betaCreate() / Sandbox.beta_create()

Messaging is refreshed by removing beta framing, renaming the limitations section, and linking to the new
AutoResume page.

A lifecycle-page cross-link is also added to direct users to the new AutoResume guide.


Pages Changed

Page Path Change Type What Changed
Docs navigation docs.json Updated Added docs/sandbox/auto-resume to the Sandbox nav group.
Sandbox lifecycle overview docs/sandbox.mdx Updated Added a link to the AutoResume page for timeout/ pause/auto-resume lifecycle behavior.
AutoResume docs/sandbox/auto-resume.mdx New Added a full guide for lifecycle auto-resume config, behavior matrix, and JS/Python examples (web servers, agents/tools, per-user sandboxes).
Persistence docs/sandbox/persistence.mdx Updated Migrated examples from beta APIs to stable APIs, switched auto-pause docs to lifecycle config with autoResume / auto_resume, refreshed limitations/beta wording, and linked to the AutoResume guide.

New Page

Page Path
AutoResume docs/sandbox/auto-resume.mdx

Note

Low Risk
Documentation-only changes that update examples and navigation; risk is limited to potential confusion if the documented API shape diverges from SDK behavior.

Overview
Adds a new Sandbox AutoResume guide documenting the lifecycle create-time config (onTimeout: 'pause' + autoResume/auto_resume) with JS/Python examples and common use cases, and surfaces it in the Sandbox navigation.

Updates sandbox lifecycle/persistence docs and related “Related guides” cards to frame pause/resume + auto-resume as Developer Preview, and refreshes examples to use the non-beta APIs (sandbox.pause() and Sandbox.create(..., lifecycle={...})) instead of betaPause/betaCreate.

Written by Cursor Bugbot for commit 081d3e6. This will update automatically on new commits. Configure here.

@matthewlouisbrockman
Copy link
Copy Markdown
Contributor Author

k launching

@matthewlouisbrockman matthewlouisbrockman merged commit ac188ed into main Mar 11, 2026
7 checks passed
@matthewlouisbrockman matthewlouisbrockman deleted the auto-resume-docs branch March 11, 2026 19:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants