Skip to content

Commit 48d9c10

Browse files
authored
Merge pull request #2067 from dgageot/fix-broken-links
Fix broken links
2 parents 9315c91 + 7d02dd3 commit 48d9c10

13 files changed

Lines changed: 54 additions & 54 deletions

File tree

docs/community/troubleshooting/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ In API server mode, each client gets isolated sessions. If sessions are mixing u
195195

196196
- Check if MCP tools are adding latency (visible in debug logs)
197197
- Use the `/cost` command in TUI to see token usage and identify expensive interactions
198-
- For DMR, consider enabling [speculative decoding](/providers/dmr/) for faster inference
198+
- For DMR, consider enabling [speculative decoding]({{ '/providers/dmr/' | relative_url }}) for faster inference
199199

200200
### Tool resource leaks
201201

@@ -229,7 +229,7 @@ When reviewing debug logs, search for these key patterns:
229229
| `"Tool call"` | A tool is being executed |
230230
| `"Tool call result"` | Tool execution completed |
231231
| `"Stream stopped"` | Agent finished processing |
232-
| `HTTP 429` | Rate limiting — consider adding a [fallback model](/configuration/agents/) |
232+
| `HTTP 429` | Rate limiting — consider adding a [fallback model]({{ '/configuration/agents/' | relative_url }}) |
233233
| `context canceled` | Operation was interrupted (timeout or user cancel) |
234234
| `[RAG Manager]` | RAG retrieval operations |
235235
| `[Reranker]` | Reranking operations |

docs/concepts/agents/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ _Agents are the core building blocks of docker-agent. Each agent is an AI-powere
1212

1313
An agent in docker-agent is defined by:
1414

15-
- **Model** — The AI model powering it (e.g., Claude, GPT-4o, Gemini). See [Models](/concepts/models/).
15+
- **Model** — The AI model powering it (e.g., Claude, GPT-4o, Gemini). See [Models]({{ '/concepts/models/' | relative_url }}).
1616
- **Description** — A brief summary of what the agent does (used by other agents for delegation)
1717
- **Instruction** — The system prompt that defines the agent's behavior and personality
1818
- **Tools** — Capabilities like filesystem access, shell commands, or external APIs

docs/concepts/models/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Named models let you configure temperature, token limits, thinking budgets, and
5555
| Mistral | `mistral` | Mistral models | `MISTRAL_API_KEY` |
5656
| xAI | `xai` | Grok models | `XAI_API_KEY` |
5757

58-
See the [Model Providers](/providers/overview/) section for detailed configuration guides.
58+
See the [Model Providers]({{ '/providers/overview/' | relative_url }}) section for detailed configuration guides.
5959

6060
## Model Properties
6161

docs/concepts/tools/index.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -29,39 +29,39 @@ docker-agent ships with several built-in tools that require no external dependen
2929

3030
| Tool | Description |
3131
| --- | --- |
32-
| [Filesystem](/tools/filesystem/) | Read, write, list, search, and navigate files and directories |
33-
| [Shell](/tools/shell/) | Execute arbitrary shell commands in the user's environment |
34-
| [Think](/tools/think/) | Step-by-step reasoning scratchpad for planning and decision-making |
35-
| [Todo](/tools/todo/) | Task list management for complex multi-step workflows |
36-
| [Memory](/tools/memory/) | Persistent key-value storage backed by SQLite |
37-
| [Fetch](/tools/fetch/) | Make HTTP requests to external APIs and web services |
38-
| [Script](/tools/script/) | Define custom shell scripts as named tools |
39-
| [LSP](/tools/lsp/) | Connect to Language Server Protocol servers for code intelligence |
40-
| [API](/tools/api/) | Create custom tools that call HTTP APIs without writing code |
41-
| [User Prompt](/tools/user-prompt/) | Ask users questions and collect interactive input |
42-
| [Transfer Task](/tools/transfer-task/) | Delegate tasks to sub-agents (auto-enabled with `sub_agents`) |
43-
| [Background Agents](/tools/background-agents/) | Dispatch work to sub-agents concurrently |
44-
| [Handoff](/tools/handoff/) | Delegate tasks to remote agents via A2A |
45-
| [A2A](/tools/a2a/) | Connect to remote agents via the Agent-to-Agent protocol |
32+
| [Filesystem]({{ '/tools/filesystem/' | relative_url }}) | Read, write, list, search, and navigate files and directories |
33+
| [Shell]({{ '/tools/shell/' | relative_url }}) | Execute arbitrary shell commands in the user's environment |
34+
| [Think]({{ '/tools/think/' | relative_url }}) | Step-by-step reasoning scratchpad for planning and decision-making |
35+
| [Todo]({{ '/tools/todo/' | relative_url }}) | Task list management for complex multi-step workflows |
36+
| [Memory]({{ '/tools/memory/' | relative_url }}) | Persistent key-value storage backed by SQLite |
37+
| [Fetch]({{ '/tools/fetch/' | relative_url }}) | Make HTTP requests to external APIs and web services |
38+
| [Script]({{ '/tools/script/' | relative_url }}) | Define custom shell scripts as named tools |
39+
| [LSP]({{ '/tools/lsp/' | relative_url }}) | Connect to Language Server Protocol servers for code intelligence |
40+
| [API]({{ '/tools/api/' | relative_url }}) | Create custom tools that call HTTP APIs without writing code |
41+
| [User Prompt]({{ '/tools/user-prompt/' | relative_url }}) | Ask users questions and collect interactive input |
42+
| [Transfer Task]({{ '/tools/transfer-task/' | relative_url }}) | Delegate tasks to sub-agents (auto-enabled with `sub_agents`) |
43+
| [Background Agents]({{ '/tools/background-agents/' | relative_url }}) | Dispatch work to sub-agents concurrently |
44+
| [Handoff]({{ '/tools/handoff/' | relative_url }}) | Delegate tasks to remote agents via A2A |
45+
| [A2A]({{ '/tools/a2a/' | relative_url }}) | Connect to remote agents via the Agent-to-Agent protocol |
4646

4747
## MCP Tools
4848

4949
docker-agent supports the [Model Context Protocol (MCP)](https://modelcontextprotocol.io/) for extending agents with external tools. There are three ways to connect MCP tools:
5050

5151
- **Docker MCP** (recommended) — Run MCP servers in Docker containers via the [MCP Gateway](https://github.com/docker/mcp-gateway). Browse the [Docker MCP Catalog](https://hub.docker.com/search?q=&type=mcp).
5252
- **Local MCP (stdio)** — Run MCP servers as local processes communicating over stdin/stdout.
53-
- **Remote MCP (SSE / HTTP)** — Connect to MCP servers running on a network. See [Remote MCP Servers](/features/remote-mcp/).
53+
- **Remote MCP (SSE / HTTP)** — Connect to MCP servers running on a network. See [Remote MCP Servers]({{ '/features/remote-mcp/' | relative_url }}).
5454

5555
```yaml
5656
toolsets:
5757
- type: mcp
5858
ref: docker:duckduckgo
5959
```
6060
61-
See [Tool Config](/configuration/tools/#mcp-tools) for full MCP configuration reference.
61+
See [Tool Config]({{ '/configuration/tools/#mcp-tools' | relative_url }}) for full MCP configuration reference.
6262
6363
<div class="callout callout-tip">
6464
<div class="callout-title">💡 See also
6565
</div>
66-
<p>For full configuration reference, see <a href="/configuration/tools/">Tool Config</a>. For RAG (document retrieval), see <a href="/features/rag/">RAG</a>.</p>
66+
<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>
6767
</div>

docs/configuration/agents/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ agents:
6262
| `description` | string | ✓ | Brief description of the agent's purpose. Used by coordinators to decide delegation. |
6363
| `instruction` | string | ✓ | System prompt that defines the agent's behavior, personality, and constraints. |
6464
| `sub_agents` | array | ✗ | List of agent names this agent can delegate to. Automatically enables the `transfer_task` tool. |
65-
| `toolsets` | array | ✗ | List of tool configurations. See [Tool Config](/configuration/tools/). |
65+
| `toolsets` | array | ✗ | List of tool configurations. See [Tool Config]({{ '/configuration/tools/' | relative_url }}). |
6666
| `fallback` | object | ✗ | Automatic model failover configuration. |
6767
| `add_date` | boolean | ✗ | When `true`, injects the current date into the agent's context. |
6868
| `add_environment_info` | boolean | ✗ | When `true`, injects working directory, OS, CPU architecture, and git info into context. |
@@ -71,13 +71,13 @@ agents:
7171
| `code_mode_tools` | boolean | ✗ | When `true`, formats tool responses in a code-optimized format with structured output schemas. Useful for MCP gateway and programmatic access. |
7272
| `max_iterations` | int | ✗ | Maximum number of tool-calling loops. Default: unlimited (0). Set this to prevent infinite loops. |
7373
| `num_history_items` | int | ✗ | Limit the number of conversation history messages sent to the model. Useful for managing context window size with long conversations. Default: unlimited (all messages sent). |
74-
| `rag` | array | ✗ | List of RAG source names to attach to this agent. References sources defined in the top-level `rag` section. See [RAG](/features/rag/). |
74+
| `rag` | array | ✗ | List of RAG source names to attach to this agent. References sources defined in the top-level `rag` section. See [RAG]({{ '/features/rag/' | relative_url }}). |
7575
| `skills` | boolean | ✗ | Enable automatic skill discovery from standard directories. |
7676
| `commands` | object | ✗ | Named prompts that can be run with `docker agent run config.yaml /command_name`. |
7777
| `welcome_message` | string | ✗ | Message displayed to the user when a session starts. Useful for providing context or instructions. |
78-
| `handoffs` | array | ✗ | List of A2A agent configurations this agent can delegate to. See [A2A Protocol](/features/a2a/). |
79-
| `hooks` | object | ✗ | Lifecycle hooks for running commands at various points. See [Hooks](/configuration/hooks/). |
80-
| `structured_output` | object | ✗ | Constrain agent output to match a JSON schema. See [Structured Output](/configuration/structured-output/). |
78+
| `handoffs` | array | ✗ | List of A2A agent configurations this agent can delegate to. See [A2A Protocol]({{ '/features/a2a/' | relative_url }}). |
79+
| `hooks` | object | ✗ | Lifecycle hooks for running commands at various points. See [Hooks]({{ '/configuration/hooks/' | relative_url }}). |
80+
| `structured_output` | object | ✗ | Constrain agent output to match a JSON schema. See [Structured Output]({{ '/configuration/structured-output/' | relative_url }}). |
8181

8282
<div class="callout callout-warning">
8383
<div class="callout-title">⚠️ max_iterations
@@ -109,7 +109,7 @@ agents:
109109

110110
## Deferred Tool Loading
111111

112-
Toolsets support `defer` to load tools on-demand and speed up agent startup. See [Deferred Tool Loading](/configuration/tools/#deferred-tool-loading) for details.
112+
Toolsets support `defer` to load tools on-demand and speed up agent startup. See [Deferred Tool Loading]({{ '/configuration/tools/#deferred-tool-loading' | relative_url }}) for details.
113113

114114
```yaml
115115
agents:

docs/configuration/models/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ models:
4747
| `thinking_budget` | string/int | ✗ | Reasoning effort control |
4848
| `parallel_tool_calls` | boolean | ✗ | Allow model to call multiple tools at once |
4949
| `track_usage` | boolean | ✗ | Track and report token usage for this model |
50-
| `routing` | array | ✗ | Rule-based routing to different models. See [Model Routing](/configuration/routing/). |
50+
| `routing` | array | ✗ | Rule-based routing to different models. See [Model Routing]({{ '/configuration/routing/' | relative_url }}). |
5151
| `provider_opts` | object | ✗ | Provider-specific options (see provider pages) |
5252

5353
## Thinking Budget
@@ -166,7 +166,7 @@ models:
166166
max_tokens: 8192
167167
```
168168

169-
For detailed provider setup, see the [Model Providers](/providers/overview/) section.
169+
For detailed provider setup, see the [Model Providers]({{ '/providers/overview/' | relative_url }}) section.
170170

171171
## Custom Endpoints
172172

@@ -195,4 +195,4 @@ models:
195195
token_key: INTERNAL_API_KEY
196196
```
197197

198-
See [Local Models](/providers/local/) for more examples of custom endpoints.
198+
See [Local Models]({{ '/providers/local/' | relative_url }}) for more examples of custom endpoints.

docs/configuration/overview/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ metadata:
215215
| `readme` | Longer markdown description |
216216
| `version` | Semantic version string |
217217

218-
See [Agent Distribution](/concepts/distribution/) for publishing agents to registries.
218+
See [Agent Distribution]({{ '/concepts/distribution/' | relative_url }}) for publishing agents to registries.
219219

220220
## Custom Providers Section
221221

@@ -249,4 +249,4 @@ agents:
249249
| `base_url` | Base URL for the API endpoint |
250250
| `token_key` | Environment variable name for the API token |
251251

252-
See [Custom Providers](/providers/custom/) for more details.
252+
See [Custom Providers]({{ '/providers/custom/' | relative_url }}) for more details.

docs/configuration/permissions/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ permissions:
180180

181181
## Combining with Hooks
182182

183-
Permissions work alongside [hooks](/configuration/hooks/). The evaluation order is:
183+
Permissions work alongside [hooks]({{ '/configuration/hooks/' | relative_url }}). The evaluation order is:
184184

185185
1. Check **deny** patterns — if matched, tool is blocked
186186
2. Check **allow** patterns — if matched, tool is auto-approved

docs/configuration/tools/index.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,20 @@ Built-in tools are included with docker-agent and require no external dependenci
1414

1515
| Type | Description | Page |
1616
| --- | --- | --- |
17-
| `filesystem` | Read, write, list, search, navigate | [Filesystem](/tools/filesystem/) |
18-
| `shell` | Execute shell commands | [Shell](/tools/shell/) |
19-
| `think` | Reasoning scratchpad | [Think](/tools/think/) |
20-
| `todo` | Task list management | [Todo](/tools/todo/) |
21-
| `memory` | Persistent key-value storage (SQLite) | [Memory](/tools/memory/) |
22-
| `fetch` | HTTP requests | [Fetch](/tools/fetch/) |
23-
| `script` | Custom shell scripts as tools | [Script](/tools/script/) |
24-
| `lsp` | Language Server Protocol integration | [LSP](/tools/lsp/) |
25-
| `api` | Custom HTTP API tools | [API](/tools/api/) |
26-
| `user_prompt` | Interactive user input | [User Prompt](/tools/user-prompt/) |
27-
| `transfer_task` | Delegate to sub-agents (auto-enabled) | [Transfer Task](/tools/transfer-task/) |
28-
| `background_agents` | Parallel sub-agent dispatch | [Background Agents](/tools/background-agents/) |
29-
| `handoff` | A2A remote agent delegation | [Handoff](/tools/handoff/) |
30-
| `a2a` | A2A remote agent connection | [A2A](/tools/a2a/) |
17+
| `filesystem` | Read, write, list, search, navigate | [Filesystem]({{ '/tools/filesystem/' | relative_url }}) |
18+
| `shell` | Execute shell commands | [Shell]({{ '/tools/shell/' | relative_url }}) |
19+
| `think` | Reasoning scratchpad | [Think]({{ '/tools/think/' | relative_url }}) |
20+
| `todo` | Task list management | [Todo]({{ '/tools/todo/' | relative_url }}) |
21+
| `memory` | Persistent key-value storage (SQLite) | [Memory]({{ '/tools/memory/' | relative_url }}) |
22+
| `fetch` | HTTP requests | [Fetch]({{ '/tools/fetch/' | relative_url }}) |
23+
| `script` | Custom shell scripts as tools | [Script]({{ '/tools/script/' | relative_url }}) |
24+
| `lsp` | Language Server Protocol integration | [LSP]({{ '/tools/lsp/' | relative_url }}) |
25+
| `api` | Custom HTTP API tools | [API]({{ '/tools/api/' | relative_url }}) |
26+
| `user_prompt` | Interactive user input | [User Prompt]({{ '/tools/user-prompt/' | relative_url }}) |
27+
| `transfer_task` | Delegate to sub-agents (auto-enabled) | [Transfer Task]({{ '/tools/transfer-task/' | relative_url }}) |
28+
| `background_agents` | Parallel sub-agent dispatch | [Background Agents]({{ '/tools/background-agents/' | relative_url }}) |
29+
| `handoff` | A2A remote agent delegation | [Handoff]({{ '/tools/handoff/' | relative_url }}) |
30+
| `a2a` | A2A remote agent connection | [A2A]({{ '/tools/a2a/' | relative_url }}) |
3131

3232
**Example:**
3333

docs/features/cli/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ $ docker agent serve mcp agent.yaml --working-dir /path/to/project
108108
$ docker agent serve mcp agentcatalog/coder
109109
```
110110

111-
See [MCP Mode](/features/mcp-mode/) for detailed setup.
111+
See [MCP Mode]({{ '/features/mcp-mode/' | relative_url }}) for detailed setup.
112112

113113
### `docker agent serve a2a`
114114

@@ -133,7 +133,7 @@ $ docker agent serve acp [config] [flags]
133133
$ docker agent serve acp agent.yaml
134134
```
135135

136-
See [ACP](/features/acp/) for details on the Agent Client Protocol.
136+
See [ACP]({{ '/features/acp/' | relative_url }}) for details on the Agent Client Protocol.
137137

138138
### `docker agent share push` / `docker agent share pull`
139139

@@ -147,7 +147,7 @@ $ docker agent share push ./agent.yaml docker.io/username/my-agent:latest
147147
$ docker agent share pull docker.io/username/my-agent:latest
148148
```
149149

150-
See [Agent Distribution](/concepts/distribution/) for full registry workflow details.
150+
See [Agent Distribution]({{ '/concepts/distribution/' | relative_url }}) for full registry workflow details.
151151

152152
### `docker agent eval`
153153

0 commit comments

Comments
 (0)