docs: fix doc-code divergences reported in #2464#2479
Merged
dgageot merged 1 commit intodocker:mainfrom Apr 21, 2026
Merged
Conversation
rumpl
previously approved these changes
Apr 21, 2026
gtardif
previously approved these changes
Apr 21, 2026
Audit of every claim in docker#2464 against the source code, followed by targeted fixes. All 35 real issues plus one broken cross-reference discovered during review are addressed here. Schema / overview - Bump the config schema version to 8 in docs/configuration/overview and agent-schema.json (enum, examples, description) to match pkg/config/latest/parse.go (currentVersion = 8). - Document the top-level `mcps:` section for reusable MCP server definitions (pkg/config/latest/types.go, Config.MCPs). - Remove the non-existent `rag:` agent-level property from the agent reference — RAG is now attached via `toolsets:`. - Document `skills` accepting either a boolean or a list of sources (SkillsConfig supports "local" plus HTTP/HTTPS URLs). - Show `ask:` in the main permissions YAML example. Providers - Fix Nebius base URL (.com, not .ai) to match pkg/model/provider/provider.go. - Fix the provider auto-detection priority order in guides/tips (Anthropic → OpenAI → Google → Mistral → Amazon Bedrock → DMR per pkg/config/auto.go). - Add the missing built-in aliases (requesty, azure, ollama, github-copilot) to the providers overview and concepts/models tables. - Document `GEMINI_API_KEY` and the Vertex AI env vars for Google. - List `claude-opus-4-7` and `claude-haiku-4-5` in the Anthropic models table. - Add the `apac.` inference profile prefix to the Bedrock doc. - Remove the false "medium thinking by default" claim from Mistral — default thinking is only applied to OpenAI o-series models. - Add `xhigh`, `max`, and `adaptive/<level>` to the thinking-effort lists in OpenAI, xAI, and configuration/models. CLI and features - Align Docker Desktop minimum version to 4.63+ in the installation doc. - Document the `docker agent models` command and the missing `docker agent run` flags (--lean, --sandbox, --template, --sbx, --json, --session-db, --attach, --dry-run, --hide-tool-calls, --hide-tool-results). - Document `serve mcp` `--http` and `--listen` flags. - Document `serve a2a` and `serve acp` runtime flags (--working-dir, --env-from-file, --models-gateway, --code-mode-tools, --hook-*, --agent, --listen, --session-db). - Describe the real sandbox backend (docker sandbox / sbx CLI) and add --template / --sbx flags. - Fix the default `--judge-model` string to `anthropic/claude-opus-4-5-20251101` per cmd/root/eval.go. - Document the `/api/sessions/:id/steer`, `/followup`, and `/api/agents/:id/:agent_name/tools/count` endpoints. - Document the OAuth config block for remote MCP servers that don't support Dynamic Client Registration. - Expand the secrets priority chain with the credential helper and Docker Desktop providers (pkg/environment/default.go). TUI - Remove the non-existent Ctrl+L audio keybinding. - Add the missing slash commands: /clear, /copy-last, /fork, /permissions, /tools, /split-diff, /speak (plus /quit and /q aliases). - Add tab/multi-agent and yolo/sidebar keybindings (Ctrl+T/W/N/P, Ctrl+1–9, Ctrl+S, Ctrl+B, Ctrl+Y, Ctrl+O, Ctrl+G). Tools - Rewrite the `handoff` tool reference: it is local peer-to-peer, auto-enabled by `handoffs:`, not an A2A remote toolset with url/timeout fields. - Document the `fetch` tool as GET-only with `urls`, `format`, and per-call `timeout` parameters, and a 1 MB / robots.txt note. - Add `create_directory` and `remove_directory` to the filesystem tools table. - Document the shell toolset's background-job tools (`run_background_job`, `list_background_jobs`, `view_background_job`, `stop_background_job`) plus `cwd`/`timeout` parameters. - Document parameters for `background_agents` (agent/task/ expected_output/task_id), `transfer_task` (agent/task/ expected_output), and `user_prompt` (title). - Mark `name` as optional and document `headers` on the `a2a` toolset. - Add `rag`, `openapi`, `tasks`, and `model_picker` to the configuration/tools and concepts/tools tables. - Add the missing `/tools/tasks/` and `/tools/model-picker/` reference pages (cross-referenced from the tables above). Go SDK - Fix the `builtin.NewShellTool` example to use the actual 2-argument signature from pkg/tools/builtin/shell.go. Assisted-By: docker-agent
6e59536 to
1001336
Compare
gtardif
approved these changes
Apr 21, 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
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.
Audit of every claim in #2464 against the source code, followed by targeted fixes. All 35 real issues reported in the audit plus one broken cross-reference discovered during review are addressed here (36 logical fixes, squashed into a single commit).
All changes are documentation / JSON Schema only — no Go source is touched, so
mise lintandgo test ./...stay green.Coverage
Schema / overview
docs/configuration/overviewandagent-schema.json(enum, examples, description) to matchpkg/config/latest/parse.go(currentVersion = 8).mcps:section for reusable MCP server definitions (pkg/config/latest/types.go,Config.MCPs).rag:agent-level property from the agent reference — RAG is now attached viatoolsets:.skillsaccepting either a boolean or a list of sources (SkillsConfigsupports"local"plus HTTP/HTTPS URLs).ask:in the main permissions YAML example.Providers
.com, not.ai) to matchpkg/model/provider/provider.go.guides/tips(Anthropic → OpenAI → Google → Mistral → Amazon Bedrock → DMR perpkg/config/auto.go).requesty,azure,ollama,github-copilot) to the providers overview and concepts/models tables.GEMINI_API_KEYand the Vertex AI env vars for Google.claude-opus-4-7andclaude-haiku-4-5in the Anthropic models table.apac.inference profile prefix to the Bedrock doc.xhigh,max, andadaptive/<level>to the thinking-effort lists in OpenAI, xAI, and configuration/models.CLI and features
docker agent modelscommand and the missingdocker agent runflags (--lean,--sandbox,--template,--sbx,--json,--session-db,--attach,--dry-run,--hide-tool-calls,--hide-tool-results).serve mcp--httpand--listenflags.serve a2aandserve acpruntime flags (--working-dir,--env-from-file,--models-gateway,--code-mode-tools,--hook-*,--agent,--listen,--session-db).docker sandbox/sbxCLI) and add--template/--sbxflags.--judge-modelstring toanthropic/claude-opus-4-5-20251101percmd/root/eval.go./api/sessions/:id/steer,/followup, and/api/agents/:id/:agent_name/tools/countendpoints.pkg/environment/default.go).TUI
/clear,/copy-last,/fork,/permissions,/tools,/split-diff,/speak(plus/quitand/qaliases).Tools
handofftool reference: it is local peer-to-peer, auto-enabled byhandoffs:, not an A2A remote toolset withurl/timeoutfields.fetchtool as GET-only withurls,format, and per-calltimeoutparameters, and a 1 MB / robots.txt note.create_directoryandremove_directoryto the filesystem tools table.run_background_job,list_background_jobs,view_background_job,stop_background_job) pluscwd/timeoutparameters.background_agents(agent/task/expected_output/task_id),transfer_task(agent/task/expected_output), anduser_prompt(title).nameas optional and documentheaderson thea2atoolset.rag,openapi,tasks, andmodel_pickerto the configuration/tools and concepts/tools tables./tools/tasks/and/tools/model-picker/reference pages (cross-referenced from the tables above).Go SDK
builtin.NewShellToolexample to use the actual 2-argument signature frompkg/tools/builtin/shell.go.Validation
go build ./...— passesgo vet ./...— cleangofmt -l .— cleangolangci-lint run— 0 issuesgo run ./lint .— 754 files, no offensesgo test ./...— 96 packages pass, 0 failuresCloses #2464
Assisted-By: docker-agent