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:
- Whether the feature (
docker agent new) is actually available or documented
- Where to find the configuration reference (is it on GitHub or will it be moved here?)
- 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
Files:
content/manuals/ai/docker-agent/tutorial.mdcontent/manuals/ai/docker-agent/_index.mdIssue
The documentation contains visible HTML comments with TODO markers that appear in the rendered markdown:
In
tutorial.md:In
_index.md:Why this matters
Readers see these TODO comments in the documentation, which creates confusion about:
docker agent new) is actually available or documentedTODO comments are internal notes for documentation authors and should not be visible to end users.
Suggested fix
For tutorial.md:
Either:
docker agent newuntil the CLI reference existsFor _index.md:
Either:
Found by nightly documentation quality scanner