Skip to content

Commit 3eb87a0

Browse files
authored
Merge pull request #3698 from docker/docs/p2-polish
docs: add tour pointer, prompt-files subsection, and product-naming consistency
2 parents 520df16 + 484dbfe commit 3eb87a0

71 files changed

Lines changed: 415 additions & 371 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/community/contributing/index.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: "Contributing"
3-
description: "docker-agent is open source. Here's how to set up your development environment and contribute."
3+
description: "Docker Agent is open source. Here's how to set up your development environment and contribute."
44
keywords: docker agent, ai agents, community, contributing
55
weight: 10
66
canonical: https://docs.docker.com/ai/docker-agent/community/contributing/
77
---
88

9-
_docker-agent is open source. Here's how to set up your development environment and contribute._
9+
_Docker Agent is open source. Here's how to set up your development environment and contribute._
1010

1111
## Development Setup
1212

@@ -52,14 +52,14 @@ export ANTHROPIC_API_KEY=your_key_here
5252

5353
## Dogfooding
5454

55-
Use docker-agent to work on docker-agent! The project includes a specialized developer agent:
55+
Use Docker Agent to work on Docker Agent! The project includes a specialized developer agent:
5656

5757
```bash
5858
cd docker-agent
5959
docker agent run ./golang_developer.yaml
6060
```
6161

62-
This agent is an expert Go developer that understands the docker-agent codebase. Ask it questions, request fixes, or have it implement features.
62+
This agent is an expert Go developer that understands the Docker Agent codebase. Ask it questions, request fixes, or have it implement features.
6363

6464
## Core Concepts
6565

@@ -121,7 +121,7 @@ Find us on [Slack](https://dockercommunity.slack.com/archives/C09DASHHRU4) for q
121121

122122
## Code of Conduct
123123

124-
We want to keep the docker-agent community welcoming, inclusive, and collaborative. Key guidelines:
124+
We want to keep the Docker Agent community welcoming, inclusive, and collaborative. Key guidelines:
125125

126126
- **Be nice** — Be courteous, respectful, and polite. No abuse of any kind will be tolerated.
127127
- **Encourage diversity** — Make everyone feel welcome regardless of background.

docs/community/opentelemetry/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
title: "OpenTelemetry Tracing"
3-
description: "Export docker-agent traces to any OTLP backend, including Langfuse and LangSmith, for debugging agentic workflows."
3+
description: "Export Docker Agent traces to any OTLP backend, including Langfuse and LangSmith, for debugging agentic workflows."
44
keywords: docker agent, ai agents, community, opentelemetry tracing
55
weight: 40
66
canonical: https://docs.docker.com/ai/docker-agent/community/opentelemetry/
77
---
88

9-
_docker-agent can export OpenTelemetry traces of an agent run to any OTLP/HTTP backend. This is separate from [product-analytics telemetry](../telemetry/index.md) and is opt-in via the `--otel` flag._
9+
_Docker Agent can export OpenTelemetry traces of an agent run to any OTLP/HTTP backend. This is separate from [product-analytics telemetry](../telemetry/index.md) and is opt-in via the `--otel` flag._
1010

11-
When enabled, docker-agent emits OpenTelemetry GenAI (`gen_ai.*`) and MCP (`mcp.*`) spans following the [OpenTelemetry semantic conventions](https://opentelemetry.io/docs/specs/semconv/gen-ai/). Spans cover the agent turn, model calls (with token usage and cost attributes), tool calls, MCP client/server activity, sub-agent hand-offs, and provider fallbacks. W3C `traceparent` context is propagated so the whole run renders as a single connected trace tree.
11+
When enabled, Docker Agent emits OpenTelemetry GenAI (`gen_ai.*`) and MCP (`mcp.*`) spans following the [OpenTelemetry semantic conventions](https://opentelemetry.io/docs/specs/semconv/gen-ai/). Spans cover the agent turn, model calls (with token usage and cost attributes), tool calls, MCP client/server activity, sub-agent hand-offs, and provider fallbacks. W3C `traceparent` context is propagated so the whole run renders as a single connected trace tree.
1212

1313
## Enabling
1414

@@ -20,7 +20,7 @@ Without an exporter endpoint configured, spans are recorded locally as no-ops. T
2020

2121
## Configuration
2222

23-
docker-agent reads the standard OTLP environment variables:
23+
Docker Agent reads the standard OTLP environment variables:
2424

2525
| Variable | Purpose |
2626
| --- | --- |
@@ -32,7 +32,7 @@ docker-agent reads the standard OTLP environment variables:
3232
> [!NOTE]
3333
> **Base endpoint, not the full signal URL**
3434
>
35-
> Set `OTEL_EXPORTER_OTLP_ENDPOINT` to the **base** endpoint (for example `https://cloud.langfuse.com/api/public/otel`). docker-agent appends `/v1/traces` for you, matching the value documented by Langfuse and LangSmith. A bare `host:port` is also accepted and gets `https://` (or `http://` for localhost).
35+
> Set `OTEL_EXPORTER_OTLP_ENDPOINT` to the **base** endpoint (for example `https://cloud.langfuse.com/api/public/otel`). Docker Agent appends `/v1/traces` for you, matching the value documented by Langfuse and LangSmith. A bare `host:port` is also accepted and gets `https://` (or `http://` for localhost).
3636
3737
> [!WARNING]
3838
> **Message content can contain sensitive data**
@@ -88,7 +88,7 @@ docker agent run agent.yaml --otel
8888
> [!NOTE]
8989
> **Langfuse and LangSmith ingest traces only**
9090
>
91-
> Both backends accept the traces signal only. docker-agent also wires metric and log exporters at the same endpoint, so their periodic exports return `404` against trace-only backends. This is harmless to traces but appears in the debug log. Point a full OTLP collector at the endpoint if you also want metrics and logs.
91+
> Both backends accept the traces signal only. Docker Agent also wires metric and log exporters at the same endpoint, so their periodic exports return `404` against trace-only backends. This is harmless to traces but appears in the debug log. Point a full OTLP collector at the endpoint if you also want metrics and logs.
9292
9393
## Inspecting traces locally
9494

docs/community/telemetry/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
title: "Telemetry"
3-
description: "docker-agent collects anonymous usage data to help improve the tool. Telemetry can be disabled at any time."
3+
description: "Docker Agent collects anonymous usage data to help improve the tool. Telemetry can be disabled at any time."
44
keywords: docker agent, ai agents, community, telemetry
55
weight: 30
66
canonical: https://docs.docker.com/ai/docker-agent/community/telemetry/
77
---
88

9-
_docker-agent collects anonymous usage data to help improve the tool. Telemetry can be disabled at any time._
9+
_Docker Agent collects anonymous usage data to help improve the tool. Telemetry can be disabled at any time._
1010

11-
On first startup, docker-agent displays a notice about telemetry collection so you're always informed. All events are processed synchronously when recorded.
11+
On first startup, Docker Agent displays a notice about telemetry collection so you're always informed. All events are processed synchronously when recorded.
1212

1313
## Disabling Telemetry
1414

docs/community/troubleshooting/index.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: "Troubleshooting"
3-
description: "Common issues and how to resolve them when working with docker-agent."
3+
description: "Common issues and how to resolve them when working with Docker Agent."
44
keywords: docker agent, ai agents, community, troubleshooting
55
weight: 20
66
canonical: https://docs.docker.com/ai/docker-agent/community/troubleshooting/
77
---
88

9-
_Common issues and how to resolve them when working with docker-agent._
9+
_Common issues and how to resolve them when working with Docker Agent._
1010

1111
## Common Errors
1212

@@ -29,7 +29,7 @@ The agent hit its `max_iterations` limit without completing the task.
2929

3030
### Model Fallback Triggered
3131

32-
When the primary model fails, docker-agent automatically switches to fallback models. Look for log messages like `"Switching to fallback model"`.
32+
When the primary model fails, Docker Agent automatically switches to fallback models. Look for log messages like `"Switching to fallback model"`.
3333

3434
- **429 errors:** Rate limited — the cooldown period keeps using the fallback
3535
- **5xx errors:** Server issues — retries with exponential backoff first, then falls back
@@ -49,7 +49,7 @@ agents:
4949
5050
## Missing credentials or model errors
5151
52-
When docker-agent can't find a usable model at startup, it fails fast with an actionable error. The message names the exact next step. `docker agent doctor` is the fastest way to see the full picture — which providers have credentials, whether Docker Model Runner is reachable, and which model `auto` would pick.
52+
When Docker Agent can't find a usable model at startup, it fails fast with an actionable error. The message names the exact next step. `docker agent doctor` is the fastest way to see the full picture — which providers have credentials, whether Docker Model Runner is reachable, and which model `auto` would pick.
5353

5454
### Required environment variables not set
5555

@@ -109,7 +109,7 @@ If instead you see `cannot query Docker Model Runner at <url>`, Docker Model Run
109109
110110
## Debug Mode
111111

112-
The first step for any issue is enabling debug logging. This provides detailed information about what docker-agent is doing internally.
112+
The first step for any issue is enabling debug logging. This provides detailed information about what Docker Agent is doing internally.
113113

114114
```bash
115115
# Enable debug logging (writes to ~/.cagent/cagent.debug.log)
@@ -168,7 +168,7 @@ If the agent hangs or times out, check that you can reach the provider's API end
168168

169169
- Ensure the MCP tool command is installed and on your `PATH`
170170
- Check file permissions — tools need to be executable
171-
- Test MCP tools independently before integrating with docker-agent
171+
- Test MCP tools independently before integrating with Docker Agent
172172
- For Docker-based MCP tools (`ref: docker:*`), ensure Docker Desktop is running
173173

174174
### Filesystem / shell tool errors
@@ -184,7 +184,7 @@ MCP and LSP toolsets are managed by a supervisor that auto-restarts them when th
184184
- `/tools` — the unified tools dialog. Its top section lists every toolset with its current state (`Stopped`, `Starting`, `Ready`, `Degraded`, `Restarting`, `Failed`), restart count, and last error; the bottom section lists every tool the agent can call. Start here whenever a tool seems missing or stuck.
185185
- `/toolset-restart <name>` — force a supervisor-driven reconnect of the named toolset. Useful after completing OAuth, when a remote MCP server has been redeployed, or when a language server like `gopls` is unresponsive.
186186

187-
Remote MCP servers that return `401 invalid_token` (e.g. because the stored OAuth token was revoked or rotated) are now self-healing: docker-agent silently exchanges the refresh token for a new one when possible, or surfaces an OAuth re-authentication prompt on your next message when refresh is not possible. No more stuck toolsets that require a process restart — but if you want to trigger re-auth immediately, `/toolset-restart <name>` forces it right away.
187+
Remote MCP servers that return `401 invalid_token` (e.g. because the stored OAuth token was revoked or rotated) are now self-healing: Docker Agent silently exchanges the refresh token for a new one when possible, or surfaces an OAuth re-authentication prompt on your next message when refresh is not possible. No more stuck toolsets that require a process restart — but if you want to trigger re-auth immediately, `/toolset-restart <name>` forces it right away.
188188

189189
MCP tools using stdio transport must complete the initialization handshake before becoming available. If tools fail silently:
190190

@@ -196,15 +196,15 @@ MCP tools using stdio transport must complete the initialization handshake befor
196196
> [!NOTE]
197197
> **Startup tool-listing timeout**
198198
>
199-
> At startup, docker-agent queries each toolset for its tool list. If a toolset does not respond within 10 seconds (e.g. a wedged MCP stdio server that never answers `tools/list`), that toolset is skipped with a warning and the remaining toolsets load normally. The sidebar resolves showing whichever tools did load — no infinite spinner. Enable `--debug` to see the warning message, and use `/toolset-restart <name>` once the server becomes responsive.
199+
> At startup, Docker Agent queries each toolset for its tool list. If a toolset does not respond within 10 seconds (e.g. a wedged MCP stdio server that never answers `tools/list`), that toolset is skipped with a warning and the remaining toolsets load normally. The sidebar resolves showing whichever tools did load — no infinite spinner. Enable `--debug` to see the warning message, and use `/toolset-restart <name>` once the server becomes responsive.
200200
201201
If a toolset keeps crashing in a tight loop, tune the [`lifecycle`](../../configuration/tools/index.md#toolset-lifecycle) block on the toolset (e.g. raise `backoff.initial`, lower `max_restarts`, or switch to the `best-effort` profile) so a flaky dependency does not amplify into a restart storm.
202202

203203
## Configuration Errors
204204

205205
### YAML syntax issues
206206

207-
docker-agent validates config at startup and reports errors with line numbers. Common problems:
207+
Docker Agent validates config at startup and reports errors with line numbers. Common problems:
208208

209209
- Incorrect indentation (YAML is whitespace-sensitive)
210210
- Missing quotes around values containing special characters (`:`, `#`, `{`, `}`)
@@ -231,7 +231,7 @@ docker-agent validates config at startup and reports errors with line numbers. C
231231

232232
### Port conflicts
233233

234-
When running docker-agent as an API server or MCP server, ensure the port is not already in use:
234+
When running Docker Agent as an API server or MCP server, ensure the port is not already in use:
235235

236236
```bash
237237
# Check if port 8080 is in use

docs/concepts/agents/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
22
title: "Agents"
3-
description: "Agents are the core building blocks of docker-agent. Each agent is an AI-powered entity with a model, instructions, tools, and optional sub-agents."
3+
description: "Agents are the core building blocks of Docker Agent. Each agent is an AI-powered entity with a model, instructions, tools, and optional sub-agents."
44
keywords: docker agent, ai agents, concepts, agents
55
weight: 10
66
canonical: https://docs.docker.com/ai/docker-agent/concepts/agents/
77
---
88

9-
_Agents are the core building blocks of docker-agent. Each agent is an AI-powered entity with a model, instructions, tools, and optional sub-agents._
9+
_Agents are the core building blocks of Docker Agent. Each agent is an AI-powered entity with a model, instructions, tools, and optional sub-agents._
1010

1111
## What is an Agent?
1212

13-
An agent in docker-agent is defined by:
13+
An agent in Docker Agent is defined by:
1414

1515
- **Model** — The AI model powering it (e.g., Claude, GPT-5, Gemini). See [Models](../models/index.md).
1616
- **Description** — A brief summary of what the agent does (used by other agents for delegation)
@@ -34,7 +34,7 @@ agents:
3434
3535
## The Root Agent
3636
37-
Every docker-agent configuration has a **root agent** — the entry point that receives user messages. In a single-agent setup, this is the only agent. In a multi-agent setup, the root agent acts as a coordinator, delegating tasks to specialized sub-agents.
37+
Every Docker Agent configuration has a **root agent** — the entry point that receives user messages. In a single-agent setup, this is the only agent. In a multi-agent setup, the root agent acts as a coordinator, delegating tasks to specialized sub-agents.
3838
3939
> [!NOTE]
4040
> **Naming**

docs/concepts/distribution/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ _Package, share, and run agents via OCI-compatible registries — just like cont
1212

1313
## Overview
1414

15-
docker-agent agents can be pushed to any OCI-compatible registry (Docker Hub, GitHub Container Registry, etc.) and pulled/run anywhere. This makes sharing agents as easy as sharing Docker images.
15+
Docker Agent agents can be pushed to any OCI-compatible registry (Docker Hub, GitHub Container Registry, etc.) and pulled/run anywhere. This makes sharing agents as easy as sharing Docker images.
1616

1717
> [!TIP]
1818
> For CLI commands related to distribution, see [CLI Reference](../../features/cli/index.md) (`docker agent share push`, `docker agent share pull`, `docker agent alias`).
@@ -108,7 +108,7 @@ $ docker agent serve api docker.io/username/agent:latest --pull-interval 10
108108

109109
## Private Repositories
110110

111-
docker-agent supports pulling from private GitHub repositories and registries that require authentication. Use standard Docker login or GitHub authentication:
111+
Docker Agent supports pulling from private GitHub repositories and registries that require authentication. Use standard Docker login or GitHub authentication:
112112

113113
```bash
114114
# Login to a registry
@@ -122,7 +122,7 @@ $ docker agent run docker.io/myorg/private-agent:latest
122122
> [!NOTE]
123123
> **Docker Desktop credentials**
124124
>
125-
> When pulling or running an agent from a `docker.com` or `*.docker.com` HTTPS URL (e.g. `desktop.docker.com`), docker-agent automatically forwards your Docker Desktop JWT for authentication — no explicit login required when Docker Desktop is running and signed in.
125+
> When pulling or running an agent from a `docker.com` or `*.docker.com` HTTPS URL (e.g. `desktop.docker.com`), Docker Agent automatically forwards your Docker Desktop JWT for authentication — no explicit login required when Docker Desktop is running and signed in.
126126
>
127127
> Note: `docker.io` (the standard Docker Hub registry domain) is a separate domain and is **not** covered by automatic JWT forwarding. Agents pulled from `docker.io` or `registry-1.docker.io` still require `docker login docker.io` for private repositories.
128128

docs/concepts/models/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
22
title: "Models"
3-
description: "Models are the AI brains behind your agents. docker-agent supports multiple providers and flexible configuration."
3+
description: "Models are the AI brains behind your agents. Docker Agent supports multiple providers and flexible configuration."
44
keywords: docker agent, ai agents, concepts, models
55
weight: 20
66
canonical: https://docs.docker.com/ai/docker-agent/concepts/models/
77
---
88

9-
_Models are the AI brains behind your agents. docker-agent supports multiple providers and flexible configuration._
9+
_Models are the AI brains behind your agents. Docker Agent supports multiple providers and flexible configuration._
1010

1111
## Inline vs. Named Models
1212

@@ -63,7 +63,7 @@ agents:
6363
instruction: You are a helpful assistant.
6464
```
6565

66-
At load time, docker-agent selects the first candidate whose credentials are
66+
At load time, Docker Agent selects the first candidate whose credentials are
6767
configured. You only need credentials for one candidate. See
6868
[Model Configuration](../../configuration/models/index.md#first-available-models)
6969
for details.
@@ -129,11 +129,11 @@ Control how much the model "thinks" before responding:
129129
| Anthropic | int or str | 1024–32768 tokens, or `adaptive`, `adaptive/<effort>`, effort level | off |
130130
| Gemini 2.5 | int | 0 (off), -1 (dynamic), or token count | -1 (dynamic) |
131131
| Gemini 3 | string | `minimal`, `low`, `medium`, `high` | varies |
132-
| All | string/int | `none` or `0` clears docker-agent's local config | — |
132+
| All | string/int | `none` or `0` clears Docker Agent's local config | — |
133133

134134
`none` and `0` are not universal API-level disable switches. On genuine OpenAI
135135
gpt-5.6+ endpoints (Sol/Terra/Luna), `none` is a real `reasoning_effort` value
136-
that docker-agent sends as-is and the model does not reason. On older OpenAI
136+
that Docker Agent sends as-is and the model does not reason. On older OpenAI
137137
models, `none`/`0` only clear the local `thinking_budget` — omitting the field
138138
has the same effect — and the model falls back to the API's own default effort
139139
(still reasoning internally for always-reasoning models like the o-series).
@@ -162,7 +162,7 @@ models:
162162

163163
## Alloy Models
164164

165-
"Alloy models" let you use more than one model in the same conversation — docker-agent alternates between them to leverage the strengths of each:
165+
"Alloy models" let you use more than one model in the same conversation — Docker Agent alternates between them to leverage the strengths of each:
166166

167167
```yaml
168168
agents:

0 commit comments

Comments
 (0)