Skip to content

[docs-scanner] Visible TODO comments in Docker Agent documentation #25385

@docker-agent

Description

@docker-agent

Files:

  • content/manuals/ai/docker-agent/tutorial.md
  • content/manuals/ai/docker-agent/_index.md

Issue

The documentation contains visible HTML comments with TODO markers that appear in the rendered markdown:

In tutorial.md:

  • Use docker agent new to generate agent teams with AI

In _index.md:

Why this matters

Readers see these TODO comments in the documentation, which creates confusion about:

  1. Whether the feature (docker agent new) is actually available or documented
  2. Where to find the configuration reference (is it on GitHub or will it be moved here?)
  3. The completeness and reliability of the documentation

TODO comments are internal notes for documentation authors and should not be visible to end users.

Suggested fix

For tutorial.md:
Either:

  • Remove the bullet point about docker agent new until the CLI reference exists
  • Link to the actual CLI reference if it exists
  • Remove the TODO comment and link to the GitHub repository if that's the current source of truth

For _index.md:
Either:

  • Keep the GitHub link and remove the TODO comment (if the GitHub README is the official reference)
  • Create the configuration reference page on the docs site and update the link
  • Remove the TODO comment to avoid confusing readers about future plans

Found by nightly documentation quality scanner

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions