docs: restructure sandbox docs with persistence-first framing#170
Draft
docs: restructure sandbox docs with persistence-first framing#170
Conversation
Rename nested Core/Guides subgroups to flat top-level "Sandbox core" and "Sandbox guides" groups. Move Code Interpreting section between MCP gateway and CLI in the sidebar.
…lifecycle into lifecycle + persistence - Rewrite sandbox.mdx overview with state diagram, key characteristics, and quick setup code showing persistent sandbox configuration - Extract persistence content (pause/resume, auto-pause, auto-resume, snapshots) from lifecycle.mdx into new persistence.mdx page - Add description frontmatter to overview, lifecycle, and persistence pages - Update docs.json navigation to include persistence page - Update redirects: snapshots and auto-resume now point to persistence - Update cross-references in 7 agent/use-case pages to link to persistence
…ates New guide covering patterns for when you can't bake everything into a template: installing packages at runtime, uploading files, environment variables, start_cmd overrides, and combining patterns. Includes snapshot-based caching for repeated setups.
…M discoverability
beran-t
changed the title
Restructure from ~9 H2 sections to 4: - Sandbox state transitions - Pause and resume (merges pausing, resuming, listing, removing, timeout) - Auto-pause and auto-resume (merges auto-pause and autoresume sections) - Snapshots
…nce page Resolves conflicts from PR #174 (timeout after auto-resume) by adding the new "Timeout after auto-resume" section to the consolidated persistence page. Removes auto-resume.mdx (already merged into persistence).
… Sandbox section - Create docs/sandbox/filesystem.mdx (merged 6 pages) - Create docs/sandbox/volumes.mdx (merged 6 pages) - Create docs/sandbox/mcp.mdx (merged 5 pages, available-servers kept separate) - Merge commands.run/streaming/background into existing sandbox/commands.mdx - Add redirects for all old URLs - Update cross-references in security, claude-code pages - Add new cards to sandbox overview
Old pages are now consolidated into sandbox section pages. Redirects preserve all old URLs.
…are for cross-sandbox storage
The page content (timeouts, metadata, list/filter, connect, shutdown) is about sandbox management, not lifecycle per se. The actual lifecycle story is on overview + persistence pages.
…ages None of the sandbox section examples use run_code or code interpreter features, so they should import from 'e2b' / 'from e2b import' instead of the code-interpreter package.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
descriptionfrontmatter to all sandbox pages for SEO and LLM discoverability