Skip to content

Commit 2d91bcb

Browse files
dgageotdgageot
authored
Merge pull request #2285 from dgageot/board/fix-docker-agent-issue-2282-c3c3091b
Fix markdown rendering in documentation callout notes
2 parents 2021b77 + 390cd28 commit 2d91bcb

52 files changed

Lines changed: 108 additions & 108 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: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ _docker-agent is open source. Here's how to set up your development environment
1717
- [Task 3.44](https://taskfile.dev/installation/) or higher
1818
- [golangci-lint](https://golangci-lint.run/docs/welcome/install/local/)
1919

20-
<div class="callout callout-info">
20+
<div class="callout callout-info" markdown="1">
2121
<div class="callout-title">ℹ️ Platform Support
2222
</div>
2323
<p>macOS and Linux are fully supported for development. On Windows, use <code>task build-local</code> to build via Docker.</p>
@@ -86,7 +86,7 @@ Key conventions:
8686

8787
File issues on the [GitHub issue tracker](https://github.com/docker/docker-agent/issues). Please:
8888

89-
<div class="callout callout-info">
89+
<div class="callout callout-info" markdown="1">
9090
<div class="callout-title">ℹ️ See also
9191
</div>
9292
<a href="{{ '/community/troubleshooting/' | relative_url }}">Troubleshooting</a> — Common issues and debug mode. <a href="{{ '/community/telemetry/' | relative_url }}">Telemetry</a> — What data is collected and how to opt out.
@@ -105,7 +105,7 @@ File issues on the [GitHub issue tracker](https://github.com/docker/docker-agent
105105
4. **Sign** your commits with `git commit -s` (DCO required)
106106
5. **Open a pull request** against the `main` branch
107107

108-
<div class="callout callout-tip">
108+
<div class="callout callout-tip" markdown="1">
109109
<div class="callout-title">💡 Tip
110110
</div>
111111
<p>Use the dogfooding agent (<code>docker agent run ./golang_developer.yaml</code>) to help write and review your changes before submitting.</p>

‎docs/community/telemetry/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ $ TELEMETRY_ENABLED=false docker agent run agent.yaml
2020
$ export TELEMETRY_ENABLED=false
2121
```
2222

23-
<div class="callout callout-info">
23+
<div class="callout callout-info" markdown="1">
2424
<div class="callout-title">ℹ️ Default
2525
</div>
2626
<p>Telemetry is **enabled by default**. Set <code>TELEMETRY_ENABLED=false</code> to opt out.</p>
@@ -43,7 +43,7 @@ $ export TELEMETRY_ENABLED=false
4343
- API keys or credentials
4444
- Personally identifying information (PII)
4545

46-
<div class="callout callout-tip">
46+
<div class="callout callout-tip" markdown="1">
4747
<div class="callout-title">💡 See events locally
4848
</div>
4949
<p>Use <code>--debug</code> to see telemetry events printed to the debug log without sending them anywhere additional.</p>

‎docs/community/troubleshooting/index.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ $ docker agent run config.yaml --debug --log-file ./debug.log
6262
$ docker agent run config.yaml --otel
6363
```
6464

65-
<div class="callout callout-tip">
65+
<div class="callout callout-tip" markdown="1">
6666
<div class="callout-title">💡 Tip
6767
</div>
6868
<p>Always enable <code>--debug</code> when reporting issues. The log file contains detailed traces of API calls, tool executions, and agent interactions.</p>
@@ -146,7 +146,7 @@ docker-agent validates config at startup and reports errors with line numbers. C
146146
- MCP toolsets need either `command` (stdio), `remote` (SSE/HTTP), or `ref` (Docker)
147147
- Provider names must be one of: `openai`, `anthropic`, `google`, `amazon-bedrock`, `dmr`, etc.
148148

149-
<div class="callout callout-info">
149+
<div class="callout callout-info" markdown="1">
150150
<div class="callout-title">ℹ️ Schema Validation
151151
</div>
152152
<p>Use the <a href="https://github.com/docker/docker-agent/blob/main/agent-schema.json">JSON schema</a> in your editor for real-time config validation and autocompletion.</p>
@@ -234,7 +234,7 @@ When reviewing debug logs, search for these key patterns:
234234
| `[RAG Manager]` | RAG retrieval operations |
235235
| `[Reranker]` | Reranking operations |
236236

237-
<div class="callout callout-warning">
237+
<div class="callout callout-warning" markdown="1">
238238
<div class="callout-title">⚠️ Still stuck?
239239
</div>
240240
<p>If these steps don't resolve your issue, file a bug on the <a href="https://github.com/docker/docker-agent/issues">GitHub issue tracker</a> with your debug log attached, or ask on <a href="https://dockercommunity.slack.com/archives/C09DASHHRU4">Slack</a>.</p>

‎docs/concepts/agents/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ agents:
3636
3737
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
39-
<div class="callout callout-info">
39+
<div class="callout callout-info" markdown="1">
4040
<div class="callout-title">ℹ️ Naming
4141
</div>
4242
<p>The first agent defined in your YAML (or the one named <code>root</code>) is the root agent by default. You can also specify which agent to start with using <code>docker agent run config.yaml -a agent_name</code>.</p>
@@ -110,7 +110,7 @@ $ docker agent alias add default /path/to/my-agent.yaml
110110
$ docker agent run # now runs your custom agent
111111
```
112112

113-
<div class="callout callout-tip">
113+
<div class="callout callout-tip" markdown="1">
114114
<div class="callout-title">💡 See also
115115
</div>
116116
<p>For reusable task-specific instructions, see <a href="{{ '/features/skills/' | relative_url }}">Skills</a>. For multi-agent patterns, see <a href="{{ '/concepts/multi-agent/' | relative_url }}">Multi-Agent</a>. For full config reference, see <a href="{{ '/configuration/agents/' | relative_url }}">Agent Config</a>.</p>

‎docs/concepts/distribution/index.md‎

Lines changed: 2 additions & 2 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
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.
1414

15-
<div class="callout callout-tip">
15+
<div class="callout callout-tip" markdown="1">
1616
<div class="callout-title">💡 Tip
1717
</div>
1818
<p>For CLI commands related to distribution, see <a href="{{ '/features/cli/' | relative_url }}">CLI Reference</a> (<code>docker agent share push</code>, <code>docker agent share pull</code>, <code>docker agent alias</code>).</p>
@@ -119,7 +119,7 @@ $ docker agent share push ./agent.yaml docker.io/myorg/private-agent:latest
119119
$ docker agent run docker.io/myorg/private-agent:latest
120120
```
121121

122-
<div class="callout callout-info">
122+
<div class="callout callout-info" markdown="1">
123123
<div class="callout-title">ℹ️ Troubleshooting
124124
</div>
125125
<p>Having issues with push/pull? See <a href="{{ '/community/troubleshooting/' | relative_url }}">Troubleshooting</a> for common registry issues.</p>

‎docs/concepts/models/index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ models:
9797
thinking_budget: none # disable thinking
9898
```
9999

100-
<div class="callout callout-info">
100+
<div class="callout callout-info" markdown="1">
101101
<div class="callout-title">ℹ️ Multi-provider teams
102102
</div>
103103
<p>Different agents can use different providers in the same config. See <a href="{{ '/concepts/multi-agent/' | relative_url }}">Multi-Agent</a> for patterns.</p>

‎docs/concepts/multi-agent/index.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ docker-agent supports two multi-agent patterns:
3434

3535
You can combine both patterns in the same configuration — an agent can have both `sub_agents` and `handoffs`.
3636

37-
<div class="callout callout-tip">
37+
<div class="callout callout-tip" markdown="1">
3838
<div class="callout-title">💡 When to use which
3939
</div>
4040
<p><strong><code>sub_agents</code></strong> — Use when a coordinator needs to send tasks to specialists and synthesize their results.</p>
@@ -62,7 +62,7 @@ transfer_task(
6262
)
6363
```
6464

65-
<div class="callout callout-info">
65+
<div class="callout callout-info" markdown="1">
6666
<div class="callout-title">ℹ️ Auto-Approved
6767
</div>
6868
<p>Unlike other tools, <code>transfer_task</code> is always auto-approved — no user confirmation needed. This allows seamless delegation between agents.</p>
@@ -94,7 +94,7 @@ handoff(
9494
)
9595
```
9696

97-
<div class="callout callout-info">
97+
<div class="callout callout-info" markdown="1">
9898
<div class="callout-title">ℹ️ Scoped Handoff Targets
9999
</div>
100100
<p>Each agent can only hand off to agents listed in its own <code>handoffs</code> array. The <code>handoff</code> tool is automatically injected — you don't need to add it manually.</p>
@@ -140,7 +140,7 @@ agents:
140140
- root
141141
```
142142
143-
<div class="callout callout-tip">
143+
<div class="callout callout-tip" markdown="1">
144144
<div class="callout-title">💡 Full pipeline example
145145
</div>
146146
<p>For a more complex handoff graph with branching and multiple processing stages, see <a href="https://github.com/docker/docker-agent/blob/main/examples/handoff.yaml"><code>examples/handoff.yaml</code></a>.</p>
@@ -212,7 +212,7 @@ External sub-agents are automatically named after their last path segment — fo
212212
- reviewer:docker.io/myorg/review-agent:latest
213213
```
214214

215-
<div class="callout callout-tip">
215+
<div class="callout callout-tip" markdown="1">
216216
<div class="callout-title">💡 Tip
217217
</div>
218218
<p>External sub-agents work with any OCI-compatible registry, not just the Docker Agent Catalog. See <a href="{{ '/concepts/distribution/' | relative_url }}">Agent Distribution</a> for more on registry references.</p>
@@ -345,7 +345,7 @@ toolsets:
345345
- **Use the right model** — Use capable models for complex reasoning, cheap models for simple tasks
346346
- **Choose the right pattern** — Use `sub_agents` for hierarchical task delegation, `handoffs` for pipeline workflows and conversational routing
347347

348-
<div class="callout callout-info">
348+
<div class="callout callout-info" markdown="1">
349349
<div class="callout-title">ℹ️ Beyond docker-agent
350350
</div>
351351
<p>For interoperability with other agent frameworks, docker-agent supports the <a href="{{ '/features/a2a/' | relative_url }}">A2A protocol</a> and can expose agents via <a href="{{ '/features/mcp-mode/' | relative_url }}">MCP Mode</a>.</p>

‎docs/concepts/tools/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ When an agent needs to perform an action, it makes a **tool call**. The docker-a
1717
3. docker-agent executes the tool and returns the result
1818
4. Agent incorporates the result and responds
1919

20-
<div class="callout callout-info">
20+
<div class="callout callout-info" markdown="1">
2121
<div class="callout-title">ℹ️ Tool Confirmation
2222
</div>
2323
<p>By default, docker-agent asks for user confirmation before executing tools that have side effects (shell commands, file writes). Use <code>--yolo</code> to auto-approve all tool calls.</p>
@@ -60,7 +60,7 @@ toolsets:
6060
6161
See [Tool Config]({{ '/configuration/tools/#mcp-tools' | relative_url }}) for full MCP configuration reference.
6262
63-
<div class="callout callout-tip">
63+
<div class="callout callout-tip" markdown="1">
6464
<div class="callout-title">💡 See also
6565
</div>
6666
<p>For full configuration reference, see <a href="{{ '/configuration/tools/' | relative_url }}">Tool Config</a>. For RAG (document retrieval), see <a href="{{ '/features/rag/' | relative_url }}">RAG</a>.</p>

‎docs/configuration/agents/index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ agents:
5151
schema: object
5252
```
5353
54-
<div class="callout callout-tip">
54+
<div class="callout callout-tip" markdown="1">
5555
<div class="callout-title">💡 See also
5656
</div>
5757
<p>For model parameters, see <a href="{{ '/configuration/models/' | relative_url }}">Model Config</a>. For tool details, see <a href="{{ '/configuration/tools/' | relative_url }}">Tool Config</a>. For multi-agent patterns, see <a href="{{ '/concepts/multi-agent/' | relative_url }}">Multi-Agent</a>.</p>
@@ -85,7 +85,7 @@ agents:
8585
| `hooks` | object | ✗ | Lifecycle hooks for running commands at various points. See [Hooks]({{ '/configuration/hooks/' | relative_url }}). |
8686
| `structured_output` | object | ✗ | Constrain agent output to match a JSON schema. See [Structured Output]({{ '/configuration/structured-output/' | relative_url }}). |
8787

88-
<div class="callout callout-warning">
88+
<div class="callout callout-warning" markdown="1">
8989
<div class="callout-title">⚠️ max_iterations
9090
</div>
9191
<p>Default is <code>0</code> (unlimited). Always set <code>max_iterations</code> for agents with powerful tools like <code>shell</code> to prevent infinite loops. A value of 20–50 is typical for development agents.</p>

‎docs/configuration/hooks/index.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ _Run shell commands at various points during agent execution for deterministic c
1212

1313
Hooks allow you to execute shell commands or scripts at key points in an agent's lifecycle. They provide deterministic control that works alongside the LLM's behavior, enabling validation, logging, environment setup, and more.
1414

15-
<div class="callout callout-info">
15+
<div class="callout callout-info" markdown="1">
1616
<div class="callout-title">ℹ️ Use Cases
1717
</div>
1818

@@ -214,14 +214,14 @@ hooks:
214214
timeout: 120 # 2 minutes
215215
```
216216

217-
<div class="callout callout-warning">
217+
<div class="callout callout-warning" markdown="1">
218218
<div class="callout-title">⚠️ Performance
219219
</div>
220220
<p>Hooks run synchronously and can slow down agent execution. Keep hook scripts fast and efficient. Consider using <code>suppress_output: true</code> for logging hooks to reduce noise.</p>
221221

222222
</div>
223223

224-
<div class="callout callout-info">
224+
<div class="callout callout-info" markdown="1">
225225
<div class="callout-title">ℹ️ Session End and Cancellation
226226
</div>
227227
<p><code>session_end</code> hooks are designed to run even when the session is interrupted (e.g., Ctrl+C). They are still subject to their configured timeout.</p>
@@ -376,7 +376,7 @@ $ docker agent run agentcatalog/coder \
376376
--hook-pre-tool-use "./audit.sh"
377377
```
378378

379-
<div class="callout callout-info">
379+
<div class="callout callout-info" markdown="1">
380380
<div class="callout-title">ℹ️ Merging behavior
381381
</div>
382382
<p>CLI hooks are <strong>appended</strong> to any hooks already defined in the agent's YAML config. They don't replace existing hooks. Pre/post-tool-use hooks added via CLI match all tools (equivalent to <code>matcher: "*"</code>).</p>

0 commit comments

Comments
 (0)