Skip to content

docs(sandbox): document Docker Sandboxes integration and published sbx templates#3682

Merged
gtardif merged 3 commits into
mainfrom
docs/sandbox-templates
Jul 16, 2026
Merged

docs(sandbox): document Docker Sandboxes integration and published sbx templates#3682
gtardif merged 3 commits into
mainfrom
docs/sandbox-templates

Conversation

@aheritier

Copy link
Copy Markdown
Contributor

What

Enhances the Sandbox Mode configuration docs (docs/configuration/sandbox/index.md) to cover Docker Agent's Docker Sandboxes integration and, in particular, the sandbox template images:

  • Explains the default --template image (docker/sandbox-templates:docker-agent), maintained by the Docker Sandboxes team, and honestly notes there is currently no automated sync of this repo's own template improvements into it.
  • Documents the templates this repo publishes via CI: docker/docker-agent-sbx-templates:latest (built on each v* release — stable) and :edge (built from main — bleeding edge), including latest-vs-edge guidance, digest pinning, and how to select one via --template or the sbx CLI.
  • Documents what the repo-published template contains (verified against the Dockerfile template stage: shell-docker base + docker-agent binary + vim/tmux + docker-mcp plugin + flavor label).
  • Links to the upstream Docker Sandboxes product docs (https://docs.docker.com/ai/sandboxes/).

Notes

Docs-only. Every image ref, flag, and tag was verified against cmd/root/run.go, .github/workflows/ci.yml, and the Dockerfile. Passes the canonical front-matter check and markdownlint.

@aheritier
aheritier requested a review from a team as a code owner July 16, 2026 13:26
@aheritier aheritier added area/docs Documentation changes kind/docs Documentation-only changes labels Jul 16, 2026
Add a 'Sandbox templates' section to the sandbox mode page explaining
the relationship between the --template default
(docker/sandbox-templates:docker-agent, maintained by the Docker
Sandboxes team) and the docker/docker-agent-sbx-templates:latest/:edge
images this repository's CI builds and publishes. Cross-link from the
--template flag row and reconcile the existing 'What the default
template includes' subsection so both sources agree on contents and
provenance.
The default `docker/sandbox-templates:docker-agent` image is
maintained by the Docker Sandboxes team, not this repo. Registry
inspection shows it does NOT share the `shell-docker` base and its
history has no docker-mcp install, so drop the unverified
base-image/docker-mcp/vim/tmux claims and scope those (verified) facts
to the repo-published `docker/docker-agent-sbx-templates` template.
Per docs/STYLE.md, shell prompts need a `$ ` marker; these two
command lines lacked it.
@aheritier
aheritier force-pushed the docs/sandbox-templates branch from cc28dc2 to 5cecf73 Compare July 16, 2026 14:02
@gtardif
gtardif merged commit 6c0b7d8 into main Jul 16, 2026
17 checks passed
@gtardif
gtardif deleted the docs/sandbox-templates branch July 16, 2026 14:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs Documentation changes kind/docs Documentation-only changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants