docs: add tour pointer, prompt-files subsection, and product-naming consistency#3698
Open
aheritier wants to merge 10 commits into
Open
docs: add tour pointer, prompt-files subsection, and product-naming consistency#3698aheritier wants to merge 10 commits into
aheritier wants to merge 10 commits into
Conversation
Mention `docker agent getting-started` after the first successful run so new users can discover the guided tour without digging through the CLI reference (not yet on main).
…ection Cover file resolution order (cwd hierarchy walk + home dir), the per-turn re-read behavior, and the --prompt-file CLI flag as the one-off equivalent, with a runnable example.
Replace prose/front-matter uses of the product name 'docker-agent' with
'Docker Agent' per STYLE.md, in docs/getting-started/installation and
docs/concepts/{agents,distribution,models,tools}.
Preserved unchanged: canonical/alias URLs, the docker/docker-agent repo
path, the docker-agent binary name and *.yaml/*.yml/*.hcl config
filenames in code blocks, and CLI-reference anchor links
(#docker-agent-setup, #docker-agent-doctor).
Replace prose/front-matter uses of 'docker-agent' with 'Docker Agent'
in docs/configuration/{hcl,hooks,models,overview,routing,sandbox,tools}.
Preserved unchanged: canonical/alias URLs, docker/docker-agent repo and
examples/ links, the docker-agent binary and sandbox template/image
identifiers (docker/sandbox-templates:docker-agent,
docker/docker-agent-sbx-templates[...], the
com.docker.sandboxes.flavor label), config filenames, and CLI anchor
links (#docker-agent-alias).
Replace prose/front-matter uses of 'docker-agent' with 'Docker Agent'
across docs/features/{a2a,acp,api-server,chat-server,cli,evaluation,
mcp-mode,remote-mcp,skills,snapshots,tui}. Also fixes one stale
command typo in remote-mcp (`docker-agent serve api` -> `docker agent
serve api`, matching the correct form used elsewhere on the same page).
Preserved unchanged: canonical/alias URLs, docker/docker-agent repo and
examples/ links, the docker-agent binary name, sandbox template image
refs, the literal MCP elicitation meta keys (docker-agent/type,
docker-agent/server_url, docker-agent/authorize_url,
docker-agent/state), a literal API JSON response value
("owned_by":"docker-agent"), config filenames, and CLI anchor links
(#docker-agent-serve-chat).
Replace prose uses of 'docker-agent' with 'Docker Agent' across
docs/tools/{open-url,shell,plan,background-jobs,mcp-catalog,lsp,mcp,rag}.
Preserved unchanged: canonical/alias URLs, docker/docker-agent
repo/examples links, and a literal HTTP header value
(X-Internal-Client: "docker-agent") in a fetch example.
Replace prose/front-matter uses of 'docker-agent' with 'Docker Agent' across all 30 docs/providers/*/index.md pages (built-in alias providers, AWS Bedrock, DMR, Mistral, OpenAI, custom providers, and the providers overview). Preserved unchanged: canonical/alias URLs, docker/docker-agent repo and examples/ links, literal HTTP header/default-value identifiers (X-Request-Source: docker-agent, role_session_name default docker-agent-bedrock-session), and config filenames (docker-agent.yaml/.yml/.hcl).
Replace prose uses of 'docker-agent' with 'Docker Agent' across
docs/guides/{go-sdk,secrets,thinking,tips}. docs/guides/compaction had
no prose occurrences to fix (only example/repo links).
Preserved unchanged: canonical/alias URLs, docker/docker-agent repo
and examples/ links, Go import paths (github.com/docker/docker-agent/pkg/...),
the docker_agent_ build-tag prefix, Docker image refs
(docker/docker-agent), config filenames, and literal shell/YAML string
values inside code blocks (notification titles, CI step names, the
get.docker-agent.dev install-script domain, and the standalone
`docker-agent run --sandbox` binary invocation).
Replace prose/front-matter uses of 'docker-agent' with 'Docker Agent'
across docs/community/{contributing,opentelemetry,telemetry,troubleshooting}.
Preserved unchanged: canonical URLs, docker/docker-agent repo/examples
links, the docker-agent binary and repo directory name, and CLI anchor
links (#docker-agent-doctor).
… sweep Revert docker-agent binary reference in mcp-catalog (executable, not product name) and convert remaining product-name prose occurrences in tools, cli, and secrets guides to Docker Agent.
aheritier
added
area/docs
dgageot
approved these changes
Jul 17, 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
2 participants
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.
Summary
Third and final wave (P2) of the docs initiative — polish and consistency. Depends on nothing; based on current
main.Changes
docker agent getting-started.add_prompt_files(config) and--prompt-file(CLI), their merge/resolution behavior, and/contextvisibility.docker-agent→ Docker Agent across ~70 docs pages in prose and front-matter, perdocs/STYLE.md. Identifiers were deliberately preserved: thedocker-agentbinary/plugin name, repo/module paths (docker/docker-agent,github.com/docker/docker-agent), canonical and doc URLs, and anything in code blocks, inline backticks, flags, filenames, or anchor slugs.Validation
Review
Locally reviewed. One false positive (executable name incorrectly renamed in the MCP catalog page) was caught and reverted; 7 remaining prose occurrences were swept for consistency. Every changed token verified as the product name in prose, not an identifier.