[Sandbox] Document v1.0 migration#31694
Conversation
aron-cf
requested review from
a team,
ghostwriternr,
scuffi,
thomasgauvin and
whoiskatrin
as code owners
Review⏸️ Automatic reviews for this PR are paused. This PR has already received 2 automatic reviews. To run another review, a codeowner can comment
Code ReviewThis code review is in beta and may not always be helpful — use your judgment. Warnings (4)
Style Guide ReviewWarnings (2)
Suggestions (1)
CommandsOnly codeowners can run commands. Post a comment with the command to trigger it.
|
|
This PR changes current filenames or deletes current files. Make sure you have redirects set up to cover the following paths:
|
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
aron-cf
changed the title
![ask-bonk[bot]](https://avatars.githubusercontent.com/in/2454580?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Summary
This PR replaces the Sandbox SDK 2026 deprecation guide with a new v1.0 migration guide, adds a changelog entry for the 1.0 preview, updates existing sandbox docs with :::note callouts about the upcoming changes, and sets up redirects for the removed deprecation page.
What changed:
- New:
src/content/docs/sandbox/guides/migrating-to-1-0.mdx— comprehensive migration guide for the 1.0 preview (consolidatedexec()API, plugins for Code Interpreter/Git/PTY, extension API, removed default sessions). - New:
src/content/changelog/sandbox/2026-07-01-announcing-sandbox-sdk-1-0-preview.mdx— announces the 1.0 preview package. - New:
src/content/docs/sandbox/migrating-to-1-0.mdx— navigation stub linking to the migration guide. - New:
public/sandbox/guides/migrating-to-1-0/SKILL.md— updated agent skill for v1.0 migration. - Deleted:
src/content/docs/sandbox/guides/2026-deprecation.mdxandpublic/sandbox/guides/2026-deprecation/SKILL.md. - Modified: 10 existing sandbox docs/API/concept pages with
:::notecallouts. - Redirect:
/sandbox/guides/2026-deprecation/→/sandbox/guides/migrating-to-1-0/.
Labels: Already correctly labeled with product:sandbox, product:changelog, and size/l. No additional labels needed.
Issues to address
- Redirect validation failure — see inline comment on
public/__redirects. - Sidebar order conflict — see inline comment on
src/content/docs/sandbox/migrating-to-1-0.mdx. - Title inconsistency — see inline comment on
src/content/docs/sandbox/migrating-to-1-0.mdx. - WIP status — the PR description says this should be considered WIP. If it's not ready for merge, consider converting it to a Draft PR to prevent accidental merges.
Build validation
pnpm run check— passed (0 errors)pnpm run format:core:check— passedpnpm run lint— passed
| /sandbox/platform/beta-info/ /sandbox/platform/ 301 | ||
| /sandbox/guides/openai-agents-sdk/ /sandbox/tutorials/openai-agents/ 301 | ||
| /sandbox/guides/2026-deprecation/ /sandbox/guides/migrating-to-1-0/ 301 | ||
| /sandbox/guides/2026-deprecation/SKILL.md /sandbox/guides/migrating-to-1-0/SKILL.md 301 |
There was a problem hiding this comment.
Redirect validation issue. Source URLs in public/__redirects must end in / (or *, .xml, .json, .html). This line ends in .md, which will fail the redirect validation step in CI (bin/validate-redirects.ts).
If external traffic hits the old skill file directly, consider whether this redirect is needed. If it is, you may need to serve the skill at a path ending in / (e.g., via an index.md or HTML wrapper) rather than with a .md extension. Otherwise, removing this line is the safest fix.
| @@ -0,0 +1,10 @@ | |||
| --- | |||
| title: Migrate to v1.0 | |||
There was a problem hiding this comment.
Title inconsistency. The linked guide uses the title "Migrate to Sandbox SDK 1.0". Consider aligning this navigation page title with the guide title so the sidebar label is consistent with the destination page. Something like Migrate to Sandbox SDK 1.0 or Migrate to Sandbox SDK v1.0 would reduce confusion.
| description: Migrate existing Sandbox SDK projects to the 1.0 preview and update deprecated APIs. | ||
| external_link: /sandbox/guides/migrating-to-1-0/ | ||
| sidebar: | ||
| order: 2 |
There was a problem hiding this comment.
Sidebar order conflict. Both this page and src/content/docs/sandbox/get-started.mdx use order: 2 in the root sandbox/ directory. This will cause a sidebar ordering conflict. Please choose a unique order value (e.g., 3, 10, or 99) for this navigation stub.
|
I've completed the review for PR #31694 and posted it directly on the pull request. What I foundSummary of changes:
Inline comments flagged (3 issues):
Other flags:
Validation:
The review is live at: #31694 (review) |
|
CI run failed: build logs |
Broken LinksFound 2 broken link(s) across 1 file(s).
|
Rebase this out before merge so the 2026-07-01 entry publishes on its intended date instead of immediately.
5 participants
Summary
We're shipping a preview branch of Sandbox SDK 1.0 which contains a number of breaking changes. This PR follows on from the prior announcement PR (#31338) with more concrete guidance on next steps.
This PR should be considered WIP until all the changes documented in the migration guide have landed on the preview branch.
Documentation checklist