Skip to content

docs(sdk): add migration guide to Together Sandbox#322

Open
christianalfoni wants to merge 6 commits into
mainfrom
docs/sdk-together-sandbox-migration
Open

docs(sdk): add migration guide to Together Sandbox#322
christianalfoni wants to merge 6 commits into
mainfrom
docs/sdk-together-sandbox-migration

Conversation

@christianalfoni

Copy link
Copy Markdown
Contributor

What

Adds a new SDK docs page: Migrate to Together Sandbox — a guide for moving from @codesandbox/sdk to together-sandbox.

New page: packages/projects-docs/pages/sdk/migrate-to-together-sandbox.mdx, linked under the Resources section in _meta.json.

Contents

  • Vocabulary mapping — template→snapshot, client, the connect()create()+start() split, namespace renames.
  • Installation & auth — package + CSB_API_KEYTOGETHER_API_KEY.
  • Client init & the core loop — before/after with the new two-step create→start.
  • Per-area before/after examples — Snapshots, lifecycle, commands (execs), filesystem (files/directories), terminals/PTY, ports, persistence/version history.
  • Features without a direct equivalent — sessions/multi-user, tasks, setup hooks, git, hosts/preview URLs, interpreters, browser preview, tracing, pricing/regions — with what to do instead.
  • Where Together is nicer — snapshot API, retry/typed errors, exec primitives, version history, SSE streaming.
  • Migration checklist.

Notes for review

  • Framed honestly: calls out gaps (no list/get, no TTL/idle auto-hibernate, no hosts/preview URLs, no sessions) and where Together improves on CodeSandbox.
  • Source material is the SDK-vs-SDK comparison; happy to adjust scope, placement in the nav, or tone.

🤖 Generated with Claude Code

Add a new SDK page walking through migrating from @codesandbox/sdk to
together-sandbox: vocabulary mapping, auth/client changes, the create→start
loop, per-namespace before/after examples (snapshots, lifecycle, execs,
filesystem, ports, versioning), gaps without a direct equivalent, and a
migration checklist.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@codesandbox-staging

Copy link
Copy Markdown

Review or Edit in CodeSandbox

Open the branch in Web EditorVS CodeInsiders

Open Preview

@codesandbox

codesandbox Bot commented Jun 15, 2026

Copy link
Copy Markdown

Review or Edit in CodeSandbox

Open the branch in Web EditorVS CodeInsiders

Open Preview

@vercel

vercel Bot commented Jun 15, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
projects-docs Ready Ready Preview, Comment Jun 15, 2026 1:08pm

Request Review

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
- Reframe intro: new infrastructure, factual tone only (no subjective claims)
- Drop client option comparisons (baseUrl/retry/tracer)
- Move "features without a direct equivalent" and the checklist near the top
- Remove the "where Together is nicer" section

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
- Part 1 "Should you migrate?" — decision overview leading with the two
  proxy requirements (previews + browser access) and the unsupported-
  functionality table
- Part 2 "Supported features" — capability→API map plus before/after usage
- Part 3 — how to implement the preview proxy and browser proxy

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
CodeSandbox is now part of Together AI. Rework the guide to recommend a
feature-parity destination first, then Together Sandbox:

- Option 1 (recommended): Daytona — closest match to the CodeSandbox SDK
  (fork, snapshots, preview URLs + token auth, terminals, git, code
  interpreters, list/get, resize, CLI), with a feature-mapping table and
  before/after examples.
- Option 2: Together Sandbox — highlights only the unsupported features and
  the two server-side pieces you must build (preview proxy, browser proxy).

Rename page to "Migration Guide" (migration-guide.mdx).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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