Skip to content

docs(sandbox): add Forking page#299

Draft
mishushakov wants to merge 4 commits into
mainfrom
forking-docs-page
Draft

docs(sandbox): add Forking page#299
mishushakov wants to merge 4 commits into
mainfrom
forking-docs-page

Conversation

@mishushakov

Copy link
Copy Markdown
Member

Adds a new Forking docs page (docs/sandbox/fork.mdx) documenting the sandbox.fork() / Sandbox.fork(sandboxId) SDK methods from e2b-dev/E2B#1554: checkpoint a running sandbox in place and boot up to 100 copies from it. The page covers the fork flow, single and multi-fork examples in JS and Python, per-fork failure handling, fork timeout, a Forking vs. Snapshots comparison, and use cases. Also registers the page in the Sandbox nav group in docs.json and cross-links it from the Snapshots use cases. Note: the SDK PR is still open and the fork endpoint (e2b-dev/infra#3202) is not deployed yet, so this should merge once those land.

🤖 Generated with Claude Code

Documents the new sandbox fork SDK methods (e2b-dev/E2B#1554): checkpoint
a running sandbox in place and boot N copies from it. Adds the page to the
Sandbox nav group and cross-links it from the Snapshots use cases.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@cla-bot cla-bot Bot added the cla-signed label Jul 15, 2026
@cursor

cursor Bot commented Jul 15, 2026

Copy link
Copy Markdown

PR Summary

Low Risk
Documentation and navigation only; no runtime, auth, or application code changes.

Overview
Adds a new Forking guide (docs/sandbox/fork.mdx) for snapshotting a running sandbox in one call and booting up to 100 independent copies via sandbox.fork() / Sandbox.fork(sandboxId), with JS/Python examples, per-fork error handling, fork timeouts, and a Forking vs. Snapshots table.

Registers Forking in the Sandbox nav in docs.json (after Snapshots) and extends the Snapshots Forking workflows bullet with a link to the new page.

Reviewed by Cursor Bugbot for commit 99bd2c5. Bugbot is set up for automated code reviews on this repo. Configure here.

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 3 potential issues.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit e27886a. Configure here.

Comment thread docs/sandbox/fork.mdx
Comment thread docs/sandbox/fork.mdx Outdated
Comment thread docs/sandbox/fork.mdx Outdated
@mintlify

mintlify Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
e2b 🟢 Ready View Preview Jul 15, 2026, 11:13 AM

@mintlify

mintlify Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
e2b 🟡 Building Jul 15, 2026, 11:08 AM

Add description frontmatter, name timeoutMs/timeout in the timeout
prose, and include the Python create_snapshot() name in the comparison
table.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
mishushakov and others added 2 commits July 15, 2026 14:05
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The docs consistently call the operation snapshotting; "checkpoint" only
appears as an informal noun. Align the Forking page (and its Snapshots
cross-link) with that vocabulary.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant