Skip to content

Fix a few issues in the docs #1924

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dgageot merged 1 commit into from
Mar 4, 2026
+16 −18
Merged

Fix a few issues in the docs #1924

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/concepts/tools/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,13 +100,13 @@ Define custom shell scripts as named tools. Unlike the generic `shell` tool wher
```yaml
toolsets:
- type: script
scripts:
- name: run_tests
shell:
run_tests:
cmd: task test
description: Run the project test suite
command: task test
- name: lint
lint:
cmd: task lint
description: Run the linter
command: task lint
```

### Transfer Task
Expand Down Expand Up @@ -144,7 +144,7 @@ toolsets:
args: ["--allow-write", "."]
tools: ["read_file", "write_file"] # optional: only expose specific tools
env:
- "RUST_LOG=debug"
RUST_LOG: debug
```

### Remote MCP (SSE / HTTP)
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/overview/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ A docker-agent YAML config has these main sections:

```bash
# 1. Version — configuration schema version (optional but recommended)
version: 5
version: 6
Copy link

@docker-agent docker-agent bot Mar 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 MEDIUM: Version Inconsistency

The example configuration was updated to use version: 6, but the documentation at line 176 still states:

"The current version is 5"

This creates confusion about which version is current. Please ensure both the example and the documentation text are updated to reflect the same version number.

Location:

version: 6


# 2. Metadata — optional agent metadata for distribution
metadata:
Expand Down
18 changes: 8 additions & 10 deletions docs/configuration/tools/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -312,9 +312,7 @@ toolsets:
args: ["-m", "mcp_server"]
tools: ["search", "fetch"] # optional: whitelist specific tools
env:
- "API_KEY=value"
env_file:
- .env
API_KEY: value
```

| Property | Type | Description |
Expand All @@ -323,7 +321,6 @@ toolsets:
| `args` | array | Command arguments |
| `tools` | array | Optional: only expose these tools |
| `env` | array | Environment variables (`"KEY=value"` format) |
| `env_file` | array | Files to load environment variables from |
| `instruction` | string | Custom instructions injected into the agent's context |

### Remote MCP (SSE / Streamable HTTP)
Expand Down Expand Up @@ -406,12 +403,13 @@ agents:
file_types: [".go"]
# Custom scripts
- type: script
run_tests:
description: Run the test suite
cmd: task test
lint:
description: Run the linter
cmd: task lint
shell:
run_tests:
description: Run the test suite
cmd: task test
lint:
description: Run the linter
cmd: task lint
# Custom API tool
- type: api
name: get_status
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/installation/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ For the latest features, or to contribute, build from source:

### Prerequisites

- [Go 1.25](https://go.dev/dl/) or higher
- [Go 1.26](https://go.dev/dl/) or higher
- [Task 3.44](https://taskfile.dev/installation/) or higher (build tool)
- [golangci-lint](https://golangci-lint.run/docs/welcome/install/#binaries) (for linting)

Expand Down