Content quality fixes for AI Sandboxes docs#25322
Merged
Merged
Conversation
Two pages linked to usage.md#signed-commits, an anchor that does not exist. The commit-signing content lives in workflows.md under the "Commit signing" heading. Point both links there. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The --branch flag was removed in sbx v0.31.0 in favor of --clone. Drop the troubleshooting section about stale host worktrees (clone mode keeps no host-side worktree, so the scenario can no longer occur) and update the architecture lifecycle note to describe clone-mode cleanup, which removes the sandbox-<name> Git remote on sbx rm. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
commands.startup[].background now keeps a service alive and replays on every container start (sbx-releases docker#2842, shipped in v0.30.0), so the nohup/& shell workaround is no longer required. Lead the background service example with background: true, drop the stale claim that the field alone leaves the service attached to an exiting shell, and remove the resolved follow-up TODO comment. Update the generic startup example in the kits reference to match. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Compose, Engine, Desktop, and Docker Agent pages live on docs.docker.com, so link to them with source-relative /manuals/ paths instead of absolute https://docs.docker.com URLs. This matches the dominant convention in the repo and lets Hugo resolve and link-check the references. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Clone-mode sandboxes enable virtiofs caching automatically as of v0.32.0, so note that the DOCKER_SANDBOXES_ENABLE_VIRTIOFS_CACHE tuning is only relevant for direct-mode workspaces. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
"seamless" is on the repo's banned hedge-word list. State plainly that a Docker account authenticates the requests. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
"The templates ... already includes uv" -> "include"; spell out "etc" as "and so on". Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
The Shell page had "Default startup command" as an h3 with no parent h2, skipping a heading level. Promote it to h2 so it sits alongside "Base image", consistent with the other agent pages. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for docsdocker ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
docker-agent
left a comment
docker-agent
left a comment
There was a problem hiding this comment.
Assessment: 🟢 APPROVE
All eight content-quality fixes look correct:
- Anchor link fixes (
usage.md#signed-commits→workflows.md#commit-signing): Bothcredentials.mdandtroubleshooting.mdnow point to the correct file and anchor (## Commit signingat line 170 ofworkflows.md). The old links were the broken ones. background: truefix: The removal of thenohup &workaround and TODO comment is justified — the PR description confirmsbackground: truewas fixed in v0.30.0 (sbx-releases #2842). The new guidance is accurate.--branchreference removal: Stale flag (removed in v0.31.0) correctly dropped from troubleshooting and architecture.- Relative links: Absolute
docs.docker.comURLs correctly converted to source-relative/manuals/…paths. - Hedge word removal: "seamless" correctly replaced with factual description in FAQ.
- Grammar fix in kits tip and heading promotion in shell.md look correct.
- virtiofs clarification (direct mode only) is accurate.
No vendored files touched. No pages removed or moved, so no redirects needed. Front matter is unchanged across all files.
docker-agent
left a comment
docker-agent
left a comment
There was a problem hiding this comment.
Assessment: 🟢 APPROVE
This PR makes eight focused content-quality fixes to the AI Sandboxes documentation. All changes are accurate, well-scoped, and follow the style guide:
- Broken anchor links fixed correctly (pointing to the right heading in
workflows.md) - Stale
--branchflag references removed cleanly commands.startup[].background: truedocumented accurately with good examples- Internal links correctly converted to source-relative form (the
_index.mdsuffix is the standard Hugo pattern used throughout this repo) - Hedge word "seamless" removed per style guide
- Subject/verb agreement and "etc" expansion are correct
- Heading hierarchy fix (h3 → h2) is appropriate
No issues found.
usha-mandya
approved these changes
Jun 10, 2026
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
3 participants
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
Content-quality audit of
content/manuals/ai/sandboxes. Eight focused fixes, one commit each:usage.md#signed-commitsanchor links (the content lives inworkflows.md#commit-signing).--branchreferences (flag removed in v0.31.0): drop the obsolete "Stale Git worktree" troubleshooting section and update the architecture lifecycle note to clone-mode cleanup.commands.startup[].background: trueas the supported way to run a kit background service (sbx-releases Fix URL for design proposal PRs #2842, shipped v0.30.0); drop the stale claim that the field alone kills the service, and remove the resolved TODO comment./manuals/…links for Compose, Engine, Desktop, and Docker Agent instead of absolutedocs.docker.comURLs.h3toh2on the Shell agent page.Generated by Claude Code