Skip to content

docs: restructure sandbox docs with persistence-first framing #170

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
beran-t wants to merge 23 commits into
base: main
Choose a base branch
from
Draft

docs: restructure sandbox docs with persistence-first framing #170

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
9b7a05d
docs: consolidate sandbox section from 19 to 8 pages with Core/Guides…
beran-t Mar 18, 2026
243e116
docs: rename nav groups and reorder Code Interpreting section
beran-t Mar 18, 2026
7e9cbf2
docs: rewrite sandbox overview with persistence-first framing, split …
beran-t Mar 18, 2026
80332be
docs: add runtime customization guide for sandbox setup without templ…
beran-t Mar 18, 2026
c4d3673
docs: add description frontmatter to all sandbox pages for SEO and LL…
beran-t Mar 18, 2026
de8930d
docs: fix runtime customization table to focus on per-user vs shared
beran-t Mar 18, 2026
ed70388
docs: fix typo and stale comment in lifecycle page
beran-t Mar 18, 2026
daa0d31
docs: consolidate persistence page headings to reduce TOC clutter
beran-t Mar 18, 2026
b3f1195
docs: flatten Sandbox core and Sandbox guides into single Sandbox group
beran-t Mar 18, 2026
cabc5f5
docs: add sidebar icons to all sandbox pages
beran-t Mar 18, 2026
a777176
docs: use detailed state diagram on overview and clarify auto-resume …
beran-t Mar 18, 2026
4afb98e
docs: merge main — incorporate auto-resume timeout docs into persiste…
beran-t Mar 30, 2026
69240cc
docs: move Filesystem, Volumes, Commands, and MCP gateway into Sandbo…
beran-t Mar 30, 2026
ae2dccd
docs: consolidate Filesystem, Volumes, Commands, and MCP gateway into…
beran-t Mar 30, 2026
8fe7325
docs: remove old Filesystem, Volumes, Commands, and MCP source files
beran-t Mar 30, 2026
e0711ea
docs: move filesystem directly after commands in sidebar
beran-t Mar 30, 2026
30ad993
docs: restore support contact info and volume diagrams on volumes page
beran-t Mar 30, 2026
657dc11
docs: clarify that sandbox filesystem is already persistent, volumes …
beran-t Mar 30, 2026
c1c68e7
docs: make sandbox filesystem note more visible with Info callout on …
beran-t Mar 30, 2026
99f80d2
docs: use Note component for volumes filesystem callout
beran-t Mar 30, 2026
49cffb6
docs: add missing redirects for deleted use-cases pages
beran-t Mar 30, 2026
439dea1
docs: rename Lifecycle page to Managing sandboxes
beran-t Mar 30, 2026
f758c0e
docs: replace code-interpreter imports with base e2b SDK in sandbox p…
beran-t Mar 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
337 changes: 245 additions & 92 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,62 +67,24 @@
"docs/agents/opencode"
]
},
{
"group": "Code interpreting",
"pages": [
{
"group": "Analyze data with AI",
"pages": [
"docs/code-interpreting/analyze-data-with-ai",
"docs/code-interpreting/analyze-data-with-ai/pre-installed-libraries"
]
},
{
"group": "Charts & visualizations",
"pages": [
"docs/code-interpreting/create-charts-visualizations",
"docs/code-interpreting/create-charts-visualizations/static-charts",
"docs/code-interpreting/create-charts-visualizations/interactive-charts"
]
},
"docs/code-interpreting/streaming",
"docs/code-interpreting/contexts",
{
"group": "Supported languages",
"pages": [
"docs/code-interpreting/supported-languages",
"docs/code-interpreting/supported-languages/python",
"docs/code-interpreting/supported-languages/javascript",
"docs/code-interpreting/supported-languages/r",
"docs/code-interpreting/supported-languages/java",
"docs/code-interpreting/supported-languages/bash"
]
}
]
},
{
"group": "Sandbox",
"pages": [
"docs/sandbox",
"docs/sandbox/lifecycle-events-api",
"docs/sandbox/lifecycle-events-webhooks",
"docs/sandbox/lifecycle",
"docs/sandbox/persistence",
"docs/sandbox/snapshots",
"docs/sandbox/auto-resume",
"docs/sandbox/commands",
"docs/sandbox/filesystem",
"docs/sandbox/configuration",
"docs/sandbox/security",
"docs/sandbox/observability",
"docs/sandbox/runtime-customization",
"docs/sandbox/git-integration",
"docs/sandbox/metrics",
"docs/sandbox/metadata",
"docs/sandbox/environment-variables",
"docs/sandbox/list",
"docs/sandbox/connect",
"docs/sandbox/internet-access",
"docs/sandbox/pty",
"docs/sandbox/ssh-access",
"docs/sandbox/connect-bucket",
"docs/sandbox/rate-limits",
"docs/sandbox/secured-access",
"docs/sandbox/ip-tunneling",
"docs/sandbox/custom-domain"
"docs/sandbox/proxy-tunneling",
"docs/sandbox/custom-domain",
"docs/sandbox/volumes",
"docs/sandbox/mcp",
"docs/sandbox/mcp/available-servers"
]
},
{
Expand Down Expand Up @@ -156,45 +118,36 @@
]
},
{
"group": "Filesystem",
"pages": [
"docs/filesystem",
"docs/filesystem/read-write",
"docs/filesystem/info",
"docs/filesystem/watch",
"docs/filesystem/upload",
"docs/filesystem/download"
]
},
{
"group": "Volumes",
"pages": [
"docs/volumes",
"docs/volumes/manage",
"docs/volumes/mount",
"docs/volumes/read-write",
"docs/volumes/info",
"docs/volumes/upload",
"docs/volumes/download"
]
},
{
"group": "Commands",
"pages": [
"docs/commands",
"docs/commands/streaming",
"docs/commands/background"
]
},
{
"group": "MCP gateway",
"group": "Code interpreting",
"pages": [
"docs/mcp",
"docs/mcp/quickstart",
"docs/mcp/available-servers",
"docs/mcp/custom-templates",
"docs/mcp/custom-servers",
"docs/mcp/examples"
{
"group": "Analyze data with AI",
"pages": [
"docs/code-interpreting/analyze-data-with-ai",
"docs/code-interpreting/analyze-data-with-ai/pre-installed-libraries"
]
},
{
"group": "Charts & visualizations",
"pages": [
"docs/code-interpreting/create-charts-visualizations",
"docs/code-interpreting/create-charts-visualizations/static-charts",
"docs/code-interpreting/create-charts-visualizations/interactive-charts"
]
},
"docs/code-interpreting/streaming",
"docs/code-interpreting/contexts",
{
"group": "Supported languages",
"pages": [
"docs/code-interpreting/supported-languages",
"docs/code-interpreting/supported-languages/python",
"docs/code-interpreting/supported-languages/javascript",
"docs/code-interpreting/supported-languages/r",
"docs/code-interpreting/supported-languages/java",
"docs/code-interpreting/supported-languages/bash"
]
}
]
},
{
Expand Down Expand Up @@ -3712,6 +3665,116 @@
}
},
"redirects": [
{
"source": "/docs/filesystem",
"destination": "/docs/sandbox/filesystem",
"permanent": true
},
{
"source": "/docs/filesystem/read-write",
"destination": "/docs/sandbox/filesystem",
"permanent": true
},
{
"source": "/docs/filesystem/info",
"destination": "/docs/sandbox/filesystem",
"permanent": true
},
{
"source": "/docs/filesystem/watch",
"destination": "/docs/sandbox/filesystem",
"permanent": true
},
{
"source": "/docs/filesystem/upload",
"destination": "/docs/sandbox/filesystem",
"permanent": true
},
{
"source": "/docs/filesystem/download",
"destination": "/docs/sandbox/filesystem",
"permanent": true
},
{
"source": "/docs/volumes",
"destination": "/docs/sandbox/volumes",
"permanent": true
},
{
"source": "/docs/volumes/manage",
"destination": "/docs/sandbox/volumes",
"permanent": true
},
{
"source": "/docs/volumes/mount",
"destination": "/docs/sandbox/volumes",
"permanent": true
},
{
"source": "/docs/volumes/read-write",
"destination": "/docs/sandbox/volumes",
"permanent": true
},
{
"source": "/docs/volumes/info",
"destination": "/docs/sandbox/volumes",
"permanent": true
},
{
"source": "/docs/volumes/upload",
"destination": "/docs/sandbox/volumes",
"permanent": true
},
{
"source": "/docs/volumes/download",
"destination": "/docs/sandbox/volumes",
"permanent": true
},
{
"source": "/docs/commands",
"destination": "/docs/sandbox/commands",
"permanent": true
},
{
"source": "/docs/commands/streaming",
"destination": "/docs/sandbox/commands",
"permanent": true
},
{
"source": "/docs/commands/background",
"destination": "/docs/sandbox/commands",
"permanent": true
},
{
"source": "/docs/mcp",
"destination": "/docs/sandbox/mcp",
"permanent": true
},
{
"source": "/docs/mcp/quickstart",
"destination": "/docs/sandbox/mcp",
"permanent": true
},
{
"source": "/docs/mcp/available-servers",
"destination": "/docs/sandbox/mcp/available-servers",
"permanent": true
},
{
"source": "/docs/mcp/custom-templates",
"destination": "/docs/sandbox/mcp",
"permanent": true
},
{
"source": "/docs/mcp/custom-servers",
"destination": "/docs/sandbox/mcp",
"permanent": true
},
{
"source": "/docs/mcp/examples",
"destination": "/docs/sandbox/mcp",
"permanent": true
},
{
"source": "/docs/template/aliases",
"destination": "/docs/template/names",
Expand Down Expand Up @@ -3824,7 +3887,7 @@
},
{
"source": "/docs/legacy/sandbox/api/envs",
"destination": "/docs/sandbox/environment-variables",
"destination": "/docs/sandbox/configuration",
"permanent": true
},
{
Expand All @@ -3834,17 +3897,17 @@
},
{
"source": "/docs/legacy/sandbox/api/reconnect",
"destination": "/docs/sandbox/connect",
"destination": "/docs/sandbox/lifecycle",
"permanent": true
},
{
"source": "/docs/legacy/sandbox/api/url",
"destination": "/docs/sandbox/internet-access",
"destination": "/docs/sandbox/security",
"permanent": true
},
{
"source": "/docs/legacy/sandbox/api/metadata",
"destination": "/docs/sandbox/metadata",
"destination": "/docs/sandbox/lifecycle",
"permanent": true
},
{
Expand Down Expand Up @@ -3961,6 +4024,96 @@
"source": "/docs/git",
"destination": "/docs/sandbox/git-integration",
"permanent": true
},
{
"source": "/docs/sandbox/snapshots",
"destination": "/docs/sandbox/persistence",
"permanent": true
},
{
"source": "/docs/sandbox/auto-resume",
"destination": "/docs/sandbox/persistence",
"permanent": true
},
{
"source": "/docs/sandbox/list",
"destination": "/docs/sandbox/lifecycle",
"permanent": true
},
{
"source": "/docs/sandbox/connect",
"destination": "/docs/sandbox/lifecycle",
"permanent": true
},
{
"source": "/docs/sandbox/metadata",
"destination": "/docs/sandbox/lifecycle",
"permanent": true
},
{
"source": "/docs/sandbox/lifecycle-events-api",
"destination": "/docs/sandbox/observability",
"permanent": true
},
{
"source": "/docs/sandbox/lifecycle-events-webhooks",
"destination": "/docs/sandbox/observability",
"permanent": true
},
{
"source": "/docs/sandbox/metrics",
"destination": "/docs/sandbox/observability",
"permanent": true
},
{
"source": "/docs/sandbox/secured-access",
"destination": "/docs/sandbox/security",
"permanent": true
},
{
"source": "/docs/sandbox/internet-access",
"destination": "/docs/sandbox/security",
"permanent": true
},
{
"source": "/docs/sandbox/rate-limits",
"destination": "/docs/sandbox/security",
"permanent": true
},
{
"source": "/docs/sandbox/environment-variables",
"destination": "/docs/sandbox/configuration",
"permanent": true
},
{
"source": "/docs/sandbox/connect-bucket",
"destination": "/docs/sandbox/configuration",
"permanent": true
},
{
"source": "/docs/sandbox/pty",
"destination": "/docs/sandbox/commands",
"permanent": true
},
{
"source": "/docs/sandbox/ssh-access",
"destination": "/docs/sandbox/commands",
"permanent": true
},
{
"source": "/docs/sandbox/ip-tunneling",
"destination": "/docs/sandbox/proxy-tunneling",
"permanent": true
},
{
"source": "/docs/use-cases/agent-browser",
"destination": "/docs/use-cases/computer-use",
"permanent": true
},
{
"source": "/docs/use-cases/browser-use",
"destination": "/docs/use-cases/computer-use",
"permanent": true
}
]
}
Loading
Loading