[docs-scanner] Broken relative links in Docker Agent documentation

Open Beginner friendly
  • Is something wrong?
#26,567 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
84/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
github, markdown
Domain
documentation

Research direction

Open content/manuals/ai/docker-agent/_index.md and inspect the five relative links named in the issue; the target pages are described as living in the docker-agent repository's docs/ folder. Check those paths against the suggested destinations and update the links so readers can reach the referenced guides. Done when all five links resolve to the intended documentation.

Written by the indexing model from the issue text.

Description

File: content/manuals/ai/docker-agent/_index.md

Issue

The "What's next" section and "Configuration options" section contain five broken relative links that point to non-existent documentation paths within the docs repository:

And in the "Configuration options" section:

See the configuration reference for complete details.

These paths do not exist in content/manuals/ai/docker-agent/ — the directory only contains _index.md.

Why this matters

Readers clicking these links encounter 404 errors, preventing them from accessing essential documentation for:

  • Getting started with Docker Agent
  • Learning best practices
  • Understanding configuration options
  • Using advanced features (ACP, MCP integration)

This blocks users from progressing beyond the basic overview.

Suggested fix

The documentation exists in the docker-agent GitHub repository under the docs/ folder. Update all five links to point to the GitHub repository:

  1. ./configuration/overview/index.md → https://github.com/docker/docker-agent/blob/main/docs/configuration/overview/index.md
  2. ./getting-started/quickstart/index.md → https://github.com/docker/docker-agent/blob/main/docs/getting-started/quickstart/index.md
  3. ./guides/tips/index.md → https://github.com/docker/docker-agent/blob/main/docs/guides/tips/index.md
  4. ./features/acp/index.md → https://github.com/docker/docker-agent/blob/main/docs/features/acp/index.md
  5. ./tools/mcp/index.md → https://github.com/docker/docker-agent/blob/main/docs/tools/mcp/index.md

Alternatively, if the plan is to migrate this documentation into docs.docker.com, the links should be removed or marked as "coming soon" until the content is available.

Found by nightly documentation quality scanner

Dominant language
Markdown
Stars
4.7k
Forks
8.5k
Avg merge
2d 10h
Merged PRs (30d)
139

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from docker/docs

All issues in docker/docs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.