Skip to content

docs: sandbox behavior during lifecycle transitions#168

Open
beran-t wants to merge 1 commit intomainfrom
sandbox-lifecycle-behavior
Open

docs: sandbox behavior during lifecycle transitions#168
beran-t wants to merge 1 commit intomainfrom
sandbox-lifecycle-behavior

Conversation

@beran-t
Copy link
Contributor

@beran-t beran-t commented Mar 18, 2026

Summary

  • Add "Behavior during state transitions" section to the persistence page explaining that the SDK waits for transitions to complete — operations behave as if transitions are instant
  • Add error reference table mapping lifecycle operations (pause, connect, kill) to possible errors (NotFoundError, TimeoutError)
  • Add code example showing try/catch error handling around lifecycle operations (JS + Python)
  • Add cross-references from the lifecycle, connect, and auto-resume pages

Addresses the request from the thread: for every lifecycle method, document what happens when a user tries to use the sandbox while that operation is executing.

Note for reviewers

The error-to-operation mapping in the table is based on logical inference from SDK error types. Jakub should validate the exact mappings before merging.

Test plan

  • Run npx mintlify dev and verify the new sections render correctly on the persistence page
  • Verify anchor links from connect, auto-resume, and lifecycle pages resolve to the correct section
  • Verify the error table and code examples render properly
  • Engineering review of error-to-operation mappings

Explain what happens when users interact with a sandbox while lifecycle
operations (pause, resume, connect, kill) are in progress. Add error
reference table for lifecycle operations. Cross-reference from related pages.
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.

1 participant