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

Offen Anfängerfreundlich
#26,567 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
1/5
Geschätzter Aufwand
Unter einer Stunde
Anfängerfreundlichkeit
84/100
Issue-Typ
Bug
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
github, markdown
Bereich
documentation

Rechercherichtung

Öffne content/manuals/ai/docker-agent/_index.md und prüfe die fünf relativen Links, die im Issue genannt werden. Die Zielseiten sollen sich im Ordner docs/ des docker-agent-Repositorys befinden. Vergleiche diese Pfade mit den vorgeschlagenen Zielen und aktualisiere die Links, damit Leser die referenzierten Anleitungen erreichen können. Fertig ist die Aufgabe, wenn alle fünf Links zur vorgesehenen Dokumentation führen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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

Vorherrschende Sprache
Markdown
Sterne
4.7k
Forks
8.5k
Ø Merge
2 T. 8 Std.
Gemergte PRs (30 T.)
129

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus docker/docs

Alle Issues in docker/docs

Ähnliche Issues

Weitere Issues zu Documentation

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.