Skip to content

Update API index file for sandboxes - #26208

Closed
macosx-fromsource wants to merge 1482 commits into
docker:dependabot/npm_and_yarn/npm_and_yarn-66413a1f6efrom
macosx-fromsource:patch-3
Closed

macosx-fromsource wants to merge 1482 commits into
docker:dependabot/npm_and_yarn/npm_and_yarn-66413a1f6efrom
macosx-fromsource:patch-3

Conversation

@macosx-fromsource

Copy link
Copy Markdown

Description

Related issues or tickets

Reviews

  • Technical review
  • Editorial review
  • Product review

dvdksn and others added 30 commits August 20, 2026 10:18
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
## Description

The sbxenv docs
[document](https://docs.docker.com/ai/sandboxes/sandbox-environments/#workspace)
the direct mount risks, mirroring them here for completeness.
## Related issues or tickets


## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [x] Editorial review
- [x] Product review
…es-ia

docs: reorganize Docker Sandboxes content
The kit reference did not state that setup.files runs as the non-root agent user. Document the UID 1000 write restriction and direct root-owned path writes to setup.install.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
<!--Delete sections as needed -->

## Description

DVP documentation updates across 4 files. Product updates only.
Billing/subscription workflows in separate PR:

- DVP is now sold in Starter/Growth tiers — reflected in
`dvp-program.md` (pricing language, tier-gated benefits) and
`insights-analytics.md` (reports split by tier)
- Co-marketing is no longer a program benefit — removed from
`dvp-program.md`
- A new Benchmark report is available (Growth tier) — documented in
`insights-analytics.md`
- Support SLAs now vary for DVP orgs without a Docker Pro/Team/Business
subscription (new self-serve orgs can lack one) — added to
`content/manuals/support/_index.md`
- Program is now self-serve — announced in `release-notes.md`

**Previews**
-
https://deploy-preview-25891--docsdocker.netlify.app/docker-hub/repos/manage/trusted-content/dvp-program/
-
https://deploy-preview-25891--docsdocker.netlify.app/docker-hub/repos/manage/trusted-content/insights-analytics/
-
https://deploy-preview-25891--docsdocker.netlify.app/docker-hub/release-notes/
-
https://deploy-preview-25891--docsdocker.netlify.app/support/#support-response-times

The current product landing page is linked 

## Related issues or tickets

ENGDOCS-3340

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review

---------

Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
Co-authored-by: Usha Mandya <47779042+usha-mandya@users.noreply.github.com>
## Summary

Add a Docker Verified Publisher (DVP) plan page covering Starter and
Growth, including apply, tracked companies, and billing. Also list DVP
on the subscription overview and plans index.

Related: docker#25891 (product/program
updates; this PR covers billing and subscription workflows)

---------

Co-authored-by: Cursor <cursoragent@cursor.com>
The general AI ownership rule also covered sandbox governance documentation. Add a narrower rule assigning governance and audit log pages to Craig Osterhout.\n\nCo-Authored-By: Claude <noreply@anthropic.com>
Align DVP Starter/Growth reports and apply steps with the Hub landing
page and Insights docs, and adjust plan sidebar weights and linkTitles.

---------

Co-authored-by: Cursor <cursoragent@cursor.com>
Clarify that .sbxenv.yaml must stay outside the primary workspace and any additionalWorkspaces mounts, and make the direct-mount warning explicit in the field reference.

Change notes:
- content/manuals/ai/sandboxes/configuration/environment-files.md - clarify that environment files must stay outside every mounted workspace
docker-agent: sync docs with docker-agent v1.126.0
The t3code kit in sbx-kits-contrib installs the build toolchain and the
t3 npm package at sandbox creation, replacing the manual apt-get setup
as the recommended path. Keep the manual install as the fallback for
existing sandboxes.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…quisites

docs(sandboxes): recommend the t3code kit for T3 Code prerequisites
…wner

docs: assign AI governance code owner
…rmissions

docs: clarify setup.files permissions
<!--Delete sections as needed -->

## Description

<!-- Tell us what you did and why -->

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review

---------

Signed-off-by: aevesdocker <allie.sadler@docker.com>
The scheduled curation workflow adds operational complexity to an editorial task that requires human review.
Remove the automation and tune the retained skill to report decisions directly without workflow-specific handoff files.

Co-Authored-By: Claude <noreply@anthropic.com>
…26-08-23

docs: update what's new for 2026-08-23
…v-file-placement

docs(sandboxes): clarify environment file placement across mounted workspaces
<!--Delete sections as needed -->

## Description

<!-- Tell us what you did and why -->

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review

Signed-off-by: aevesdocker <allie.sadler@docker.com>
<!--Delete sections as needed -->

## Description

- Updated wording for `tracked companies` -> `consuming domains`. ~Some
UI wording has yet to be updated and remains aligned in docs. Will
update docs as UI updates.~
- Grouped consuming domains and technographic report into domain-level
reports.

## Related issues or tickets

ENGDOCS-3367

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review

---------

Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
…fault

docs(engine) clarify seccomp default profile
build.network was showing `custom_network_1`, which looks like a
user-defined Compose network. it's the RUN networking mode (`default` /
`none` / `host`), same as `docker build --network`.

@netlify /reference/compose-file/build/

Fixes docker#21982

Signed-off-by: Dean Chen <862469039@qq.com>
mcp: add Mistral Vibe to verify connections section
## Summary

Remove the scheduled What's New curation workflow and its dedicated
agent configuration. Tune the retained skill for manual use: report
every selected entry explicitly, summarize retained and expired entries,
limit exclusion notes to credible candidates, and avoid
workflow-specific `.pr-body.md` files.

Generated by Codex

Co-authored-by: Claude <noreply@anthropic.com>
dvdksn and others added 23 commits September 24, 2026 18:00
Add v3 kit documentation for Docker Sandboxes: concepts, usage,
authoring, and kit sets. Link to the upstream specification for
reference details and retain v2 guidance.

Validation: Markdown/style checks, Hugo build, internal links, and
example build checks passed.

Closes docker/sbx-releases#569

@netlify /ai/sandboxes/customize/
## Description

Add an experimental Sandboxes API and SDK section alongside Docker
Sandboxes under AI and agents, at `/ai/sandboxes-api/`. Cover
installation of `@docker/sandboxes`, browser and PAT authentication, and
a TypeScript walkthrough that launches the shell kit, runs a command,
and deletes the sandbox. Explain kits and image choices with examples,
along with compute sizes, quotas, permissions, resource lifecycle,
errors, and retries. Link subscription setup and billing to the shared
Docker Agentic Platform guide. Preserve the previous
`/ai/sandboxes/api/` URLs with redirects.

Uses the shared Docker Agentic Platform documentation merged in docker#26142.
Sibling to docker#26158, which introduces CLI-side Cloud Sandboxes
documentation.

Include 36 SDK cookbook recipes at `/ai/sandboxes-api/cookbook/` and the
public REST API reference at `/reference/api/sandboxes/`. Import the
generated export from `docker/sbx-api` commit `60d79c1d` (source
`1a7f4026`). Overview and installation remain maintained here. The
reference uses the shared API renderer from main, with separate
operation and schema pages, streaming and WebSocket details, and a
downloadable OpenAPI spec. An API reference link appears in the API/SDK
sidebar. A pinned manifest and import script provide the basis for later
release automation.

Examples are optional in the shared renderer; supplied examples still
have to pass schema validation. Requests without body examples use a
request-body file with instructions to prepare it. The import copies all
selected recipes and the OpenAPI specification byte for byte from the
corrected upstream export, without patches or link rewrites. The broken
naming recipe remains temporarily excluded.

This remains a draft pending validation against the published npm SDK.
The imported cookbook contains the TypeScript-only guidance, five-minute
request deadlines, kit-readiness explanation, active-policy status
requirement, and snapshot-deletion and lifetime-renewal restrictions.

Validation: scoped Markdown and Vale checks, full Hugo build, rendered
navigation, redirects, and internal links, and TypeScript type-checking
against the generated public SDK from `docker/sbx-api` commit
`68f214b9`. Import validation also covers all 60 REST operations and 188
schema definitions, 1,198 imported-page links and anchors,
desktop/mobile rendering, Markdown output, spec delivery, and a repeat
import. The shared renderer tests, strict generation for all five APIs
(zero diagnostics), full Hugo build, and verification of 453
HTML/Markdown page pairs and API links pass. No live sandbox execution.
The corrected export passes strict generation for all five APIs with
zero diagnostics, scoped Markdown/Vale lint, a full Hugo build, and
verification of 453 HTML/Markdown page pairs and API links. A repeat
import produces identical files. The spec update changes examples only;
schemas and operations are unchanged.

@netlify /ai/sandboxes-api/

Generated by Codex

---------

Co-authored-by: Claude <noreply@anthropic.com>
## Description

Add cloud Sandboxes documentation for sbx v0.45.0, covering credentials,
network policy, lifecycle, environment files, and transfers between
local and cloud sandboxes. Document named sandbox reuse and resume,
resource sizes and platform selection, custom secrets, move behavior,
and local UDP guidance.

Link to the canonical Docker Agentic Platform signup, billing, and
Console MCP instructions. Keep CLI sign-in, access checks, and cloud
credential setup in the Sandboxes guides.

This PR also vendors the CLI reference including `sbx move`, and aligns
timeout and move guidance with it. Kits v3 and API/SDK documentation are
handled separately.

Validation: scoped Markdown and Vale checks and a full Hugo build
passed. Cloud and Agentic Platform guides passed rendered internal link
and anchor checks, including the canonical signup page's discovery. The
earlier CLI import verified all 119 vendored files against upstream
byte-for-byte and checked 1,083 rendered CLI-reference links and
anchors. Behavior was checked against source; live cloud workflows and
checkout were not exercised.

@netlify /ai/sandboxes/cloud/

Generated by Codex
Fix the main CI REF_NOT_FOUND failure by pointing the Sandboxes API
concepts link to the renamed kits-v2.md page. The target matches the v2
artifact format described by the API.

Hugo build, Markdown lint, and Vale pass.

@netlify /ai/sandboxes-api/concepts/

Generated by Codex
…#26179)

The Sandboxes API workflow links to the v2 kit reference, whose general
recommendation to use v3 can confuse API readers. Explain that the
documented API artifacts use v2, and scope the v3 development
recommendation to the `sbx` CLI.

Follow-up to docker#26178. Markdown lint and Vale pass for both changed pages.

@netlify /ai/sandboxes-api/concepts/

Generated by Codex
Baby step towards cleaning up the sidenav for the ai/agents section.

<img width="306" height="304" alt="image"
src="https://github.com/user-attachments/assets/57ebd1df-9c7f-4ee8-a84f-a61ffec2cd90"
/>


Moves “Use AI models in Compose” into Compose → How-tos and MCP Catalog
and Toolkit into Docker Desktop → Features and capabilities, removing
both entries from the top-level AI and agents sidebar group.

Updates internal source links and preserves existing public URLs. Scoped
lint and a Hugo build passed; rendered sidebar ancestry, MCP page URLs,
and images were checked locally.

Generated by Codex
API generation introduced in docker#26048 added roughly five minutes to site
builds: median successful main-branch build-workflow duration rose from
4m 05s to 8m 48s across September 3–25. The pre-build command took 4m
41s–4m 53s in each of four jobs on the merge commit.

Vendor the generated presentation model in `data/api-reference.json`,
mark it as generated, and let Docker, Netlify, and local Hugo builds
consume it directly. Keep the existing rendered-output checks.

Move generator tests, strict spec validation, and a byte-for-byte
regeneration check into `docker buildx bake validate-api-reference`,
inheriting the shared Docker base stage. The target uses the pinned
Vacuum release binary with Dockerfile ADD checksum verification and
archive extraction instead of compiling Vacuum from source. The existing
build workflow runs this target alongside the other validation matrix
entries. Only this matrix entry is advisory; its failures do not block
site builds or deployment.

Validated locally with the Docker target, rejection of deliberately
stale data, repeatable generation across directories, a production Hugo
build and verification of 453 API HTML/Markdown page pairs, workflow
syntax checks, and scoped documentation lint. The prebuilt-binary CI
check passed in 1m 40s, down from 5m 15s with source compilation. Remote
layer-cache settings were subsequently removed; local Go cache mounts
remain.

Generated by Codex
Sync the Sandboxes release notes with `hack/sbx-release-notes.py`,
adding v0.45.1 fixes and the v0.45.0 cloud-support highlight.

Scoped Markdown and Vale checks passed.

@netlify /ai/sandboxes/release-notes/

Generated by Codex
## Summary

Refresh the vendored Sandboxes cookbook and OpenAPI reference from
upstream.

Removes standalone MCP gateway start/stop documentation, imports
upstream authentication and timeout examples, auto-resume readback
guidance, and network-policy selector updates, and regenerates the API
presentation data.

@netlify /ai/sandboxes-api/cookbook/give-a-sandbox-an-mcp-gateway/

Generated by Codex
…#25798)

The cache backends overview says the default `docker` driver can use
`gha` when the containerd image store is enabled, but the GHA page still
said it was unsupported entirely.

Matched the wording used for the registry cache backend so the pages
agree.

Fixes docker#25396

Signed-off-by: Dean Chen <862469039@qq.com>
…r#25800)

The cache backends overview says `local` works with the default docker
driver when the containerd image store is enabled, but the local backend
page never said that.

Added the same driver note used on the registry (and GHA) pages.

Follow-up to the inconsistency called out in docker#25396.

Signed-off-by: Dean Chen <862469039@qq.com>
## Description

Adds an important warning to the `daemon.json` remote-access
instructions explaining that setting `hosts` this way isn't supported on
Docker Desktop for Windows or Docker Desktop for Mac. The same
limitation is already documented in the troubleshooting guide; this puts
it at the point where readers make the configuration.

## Related issues or tickets

Closes docker#26130

## Validation

- `git diff --check` passes.
- Local `rumdl` and Docker validation were unavailable in this
environment.
## Description

Updates the Docker account recovery documentation to resolve a
contradictory instruction in the 2FA recovery flow.

The previous instructions directed users who had lost both their
authenticator application and recovery code to sign in with their
username and password before selecting the recovery option. However,
completing the sign-in process requires 2FA verification, so users
without access to their authenticator or recovery code may be unable to
proceed.

This change clarifies that the normal sign-in process cannot be
completed when the required 2FA verification code is unavailable and
directs affected users to the Docker Support form using the primary
email address associated with their Docker ID.

## Changes

* Clarified the recovery process for users who have lost both their
authenticator and recovery code.
* Removed the contradictory instruction to sign in before initiating
account recovery.
* Directed users to Docker Support for further recovery instructions.
* Kept the existing 2FA recovery documentation structure and links
intact.

## Related Issue

Closes docker#26084

## Reviews

* [ ] Technical review
* [ ] Editorial review
* [ ] Product review
## Summary

Extend the Docker Docs launch timeline through September 27 and feature
three Docker Sandboxes launches.

## Selected entries

- Docker Sandboxes — Run sandboxes on Docker-managed cloud
infrastructure (docker#26142, docker#26157, docker#26158, docker#26181)
- Docker Sandboxes — Manage cloud sandboxes with the API and TypeScript
SDK (docker#26142, docker#26168)
- Docker Sandboxes — Compose sandbox environments with kits v3 (docker#26065,
docker#26157)

## Curation notes

Retained four entries and removed six entries published before the new
August 29 window. No retained entry content or sources changed.

Docker Desktop 4.92, DHI webhook metadata, API reference migrations, and
the Desktop Kubernetes command references did not meet the threshold for
a Docker-wide launch highlight.

Generated by Codex
## Summary

Add the Docker Skills launch omitted from the September curation in
docker#26195 and update the featured ranking.

## Selected entries

- Docker Skills — Give coding agents guidance with Docker Skills
(docker#26169)

## Curation notes

Retained all seven existing entries and expired none. The retained Run
agents without mounting host files entry remains in the timeline but is
no longer featured, keeping the five featured slots for the
highest-ranked launches.

Generated by Codex
<!--Delete sections as needed -->

## Description

<!-- Tell us what you did and why -->

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review

---------

Signed-off-by: aevesdocker <allie.sadler@docker.com>
<!--Delete sections as needed -->

## Description

<!-- Tell us what you did and why -->

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review

---------

Signed-off-by: aevesdocker <allie.sadler@docker.com>
<!--Delete sections as needed -->

## Description

Removes stale content and removes two pages (moves content elsewhere in
the section)
Accuracy checked against the engineering repo

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review

---------

Signed-off-by: aevesdocker <allie.sadler@docker.com>
Runs freshness tier 1 pass on Support page

To do:

- Validate info manually
- Update
- Run freshness tier 2
- Get TW review
- Merge

---------

Co-authored-by: Cursor <cursoragent@cursor.com>
Tier 1 freshness pass on `content/manuals/platform-release-notes.md`:
retitles the page to "Accounts and admin release notes" to match the
sidebar section, rewrites the description, keywords, and intro to
describe the area as accounts and admin features instead of naming the
Admin Console, wraps entries at 80 characters, fixes "Enhance Container
Isolation" to "Enhanced Container Isolation" in the 2024-11-18 entry,
and retargets two access token links from published URLs to Hugo source
paths. Historical entries that mention the Admin Console are unchanged,
and no release history was rewritten.

---------

Co-authored-by: Cursor <cursoragent@cursor.com>
<!--Delete sections as needed -->

## Description

<!-- Tell us what you did and why -->

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review

---------

Signed-off-by: aevesdocker <allie.sadler@docker.com>
Co-authored-by: Alexa Kristensen <81787716+akristen@users.noreply.github.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
@netlify

netlify Bot commented Sep 28, 2026 •

Copy link
Copy Markdown

❌ Deploy Preview for docsdocker failed. Why did it fail? →

Name Link
🔨 Latest commit 64aae90
🔍 Latest deploy log https://app.netlify.com/projects/docsdocker/deploys/6abadabe01aa2f0008c2dd83

@macosx-fromsource
macosx-fromsource changed the base branch from main to dependabot/npm_and_yarn/npm_and_yarn-66413a1f6e September 28, 2026 21:23
@dvdksn dvdksn closed this Sep 28, 2026
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.