Agent Sandbox Registry

python-sdk

Decision: Docs ownership audit — the python-sdk repository documents only the SDK

无中文版

.agents/notes/implemented/process/2026-10-12-docs-ownership-audit.md

Decision: Docs ownership audit — the python-sdk repository documents only the SDK

Status: implemented

Problem

python-sdk/docs kept near-duplicate copies of CLI pages and long abx command walkthroughs in guides, the README, AGENTS.md and llms.txt. The design index linked CLI design pages, so an SDK reader was sent to the CLI repository for SDK material and the other way round. The health check flagged byte-identical pages shared with cli/docs, and the template.yaml contract, which the SDK owns, existed twice.

Decision

  1. Ownership principle. Every page is owned by exactly one repository and describes only that repository. This repository owns the Python client SDK (agent-sandbox), the server runtime (agent-sandbox-server), the server HTTP API, the SDK architecture, the E2B compatibility layer and the template.yaml contract. The CLI repository owns the abx command surface and its distribution.
  2. Audit. Classification of every page (en and zh mirrors are in step except the English-only maintainer drafts):
Page (under docs/{en,zh}/ unless noted) Class Disposition
design/architecture, sdk-api-design, server-api, sandbox-types, built-in-agents, template-system SDK kept; CLI sections reduced to a Related: the abx CLI section
design/mcp-server shared concept kept as the SDK view (python -m agent_sandbox.agent.mcp, HTTP app, FC artifact contract); abx mcp commands moved to a pointer
design/agents-api*, fine-grained-capabilities*, provider-opensandbox-mapping, providers-and-credentials*, server-sdk-v2/*, base-image-and-server-sdk, client-server-alignment, repository-layout SDK other workers' English-only drafts; not edited (listed in the Maintainer Design Documents table of DESIGN.md)
design/agents-api-cli-followups CLI CLI-owned content that lives here; flagged, not moved (another worker owns it)
DESIGN.md, README.md, docs/README.md SDK rewritten as SDK-only indexes (docs/README.md is a short bilingual pointer)
explanation/architecture-overview, e2b-compatibility, sandbox-lifecycle SDK kept; CLI mentions reduced to pointers
guide/sdk-usage, declarative-usage, session-persistence, migrate-from-e2b, migrating-from-0.2, comparison, providers SDK kept; sdk-usage gained the agent workflow pattern
guide/build-and-deploy SDK new (en+zh): Sandbox.deploy, Image and the build/push flow as a Python API; the abx deploy command stays in the CLI
guide/getting-started, authentication, authoring-templates, mcp-integration, troubleshooting, environment-variables shared concept kept as SDK views; abx sections removed after confirming the CLI page holds them; Related: the abx CLI section
reference/api-reference, server-http-api, template-yaml-spec SDK kept; template-yaml-spec is the single owner of the template.yaml contract
reference/configuration, reference/error-codes shared concept kept as SDK views (client/server config, E* codes raised by Python); abx config command sections removed; provider-layer content is others'
CLI pages (CLI design, tutorial, reference, using templates, deploy and build command guide, binary installation, BYO agent, Agent Skill, E2E template workflow, templates catalog) CLI not present in this repository; the READMEs, AGENTS.md and llms.txt point to the CLI repository with absolute URLs
  1. Shared concepts. See the CLI ADR: view pages in both repositories, with the credential-resolution order as the only verbatim shared contract.
  2. Information moves. Content that existed only here and described the CLI was checked against the CLI docs before removal (cache and market command notes went to templates-catalog section 9 there). Content that existed only in the CLI copy and described the SDK (Sandbox.deploy, Image, the agent workflow) was moved here first.
  3. Link policy. Relative ../cli links became absolute https://github.com/alibaba-agent-sandbox/agent-sandbox/blob/main/... URLs (15 files); every page that needs the CLI has one "Related: the abx CLI" section (anchor #related-the-abx-cli, zh #相关abx-cli). The READMEs' long abx example blocks were replaced by that section because the CLI README holds the same commands.
  4. Indexes. docs/README.md, docs/{en,zh}/README.md, docs/{en,zh}/DESIGN.md, README.md, README.zh-CN.md, AGENTS.md (golden-file evidence and CLI resolution sections removed; they live in the CLI AGENTS.md) and llms.txt describe only the SDK.

API Design

N/A — this decision does not involve API changes.

Alternatives considered

Dependencies

The cli repository's matching audit (ADR), so that every section removed here exists in the CLI repository.

Test Strategy

Acceptance criteria

Consequences

Files changed

New: docs/{en,zh}/guide/build-and-deploy.md. Rewritten or pruned: pages marked above plus README.md, README.zh-CN.md, AGENTS.md, llms.txt, docs/README.md.