1
0
mirror of https://github.com/docker/docs.git synced 2026-10-23 18:09:02 +03:00
Files
David Karlsson 938f943d94 docs: refresh Sandboxes cookbook and API reference (#26188)
## 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
2026-09-25 20:34:38 +02:00
..

Sandboxes documentation import

The public cookbook export is published to the generated branch of docker/sbx-api after its documentation CI passes. source.json pins both the generated commit and the source commit recorded in that export's SOURCE file. The guide list explicitly selects the recipes to publish.

name-a-sandbox-and-find-it-again.md is temporarily excluded pending a working example. Restore its manifest entry and import it after verification.

Run the import from the repository root with Python 3 and gh authenticated for docker/sbx-api:

$ python3 hack/sync-sandboxes-docs.py

The import writes:

  • Cookbook recipes to content/manuals/ai/sandboxes-api/cookbook/
  • The public OpenAPI specification to content/reference/api/sandboxes/api.yaml

Treat these files as generated. Make prose, example, and API corrections in docker/sbx-api, then import the updated export. The cookbook's _index.md is maintained in docker/docs, along with the overview, installation, authentication, concepts, errors, and limits pages.

The import copies the selected recipes and OpenAPI specification byte for byte. It excludes the upstream overview, installation page, and generated Markdown API reference. Recipe installation links point to the canonical Docker Docs installation page.

The specification is registered in hack/api-docs/sources.json. The shared API renderer generates an overview and separate operation and schema pages under /reference/api/sandboxes/latest/, in HTML and Markdown. Run ./hack/api-docs/run.sh generate after importing a specification and commit data/api-reference.json with the source changes. Strict validation checks the specification and its examples. Fix failures upstream and re-import the export.

To update, change both commit IDs in source.json, review additions or removals in the upstream guide list, and run the import. Removed guides require explicit deletion and a link check. Review the diff and build the site before committing. The import does not select the latest release or push changes.

Release automation can update this manifest and run the same command in a pull request once upstream publishes a release-to-export mapping. Keep the source and generated commits paired rather than importing a moving branch.