Skip to content

Add sandbox snapshots documentation#115

Open
dobrac wants to merge 4 commits intomainfrom
dobrac/sandbox-env-vars
Open

Add sandbox snapshots documentation#115
dobrac wants to merge 4 commits intomainfrom
dobrac/sandbox-env-vars

Conversation

@dobrac
Copy link
Contributor

@dobrac dobrac commented Feb 17, 2026

Summary

  • Add new Snapshots documentation page (docs/sandbox/snapshots.mdx) covering creating, listing, and deleting snapshots with JS + Python code examples
  • Add Snapshots to sidebar navigation under Sandbox group
  • Update persistence page: replace static PNG state diagram with Mermaid flowchart that includes the new Snapshotting state
  • Remove unused images/diagram.png
  • Add .tool-versions for mise (Node 24.11.0)

Test plan

  • Verify the new Snapshots page renders correctly at /docs/sandbox/snapshots
  • Verify the Mermaid state diagram renders on the persistence page with all states including Snapshotting
  • Verify sidebar navigation shows Snapshots between Persistence and Git Integration
  • Verify all internal links work between snapshots and persistence pages

Note

Low Risk
Documentation-only updates plus a Node version pin; low risk aside from potential broken internal links or diagram rendering issues in the docs site.

Overview
Adds a new docs/sandbox/snapshots.mdx page documenting sandbox snapshots (create, spawn-from-snapshot, list/filter, delete) with JS/Python examples and Mermaid flow diagrams.

Updates Sandbox navigation (docs.json) to include the new Snapshots page, and refreshes lifecycle docs to mention the new checkpointed/sandbox.lifecycle.checkpointed event and link to snapshots. Replaces the persistence state diagram PNG with a Mermaid state machine that includes a new Snapshotting state and adds .tool-versions pinning Node 24.11.0.

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

- New docs/sandbox/snapshots.mdx page covering create, list, delete snapshots
- Add snapshots to sidebar navigation
- Update persistence page: replace PNG diagram with Mermaid flowchart including Snapshotting state
- Remove unused images/diagram.png
- Add .tool-versions for mise (Node 24.11.0)
New webhook/API event type for when a snapshot is created from a sandbox.
The sandbox is paused/resumed during snapshot creation, which drops
all active connections. Recommend proper reconnect handling.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

feature New feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

Comments