docs: remove visible TODO comments from Docker Agent documentation#25451
Closed
mohithshuka wants to merge 15 commits into
Closed
docs: remove visible TODO comments from Docker Agent documentation#25451mohithshuka wants to merge 15 commits into
mohithshuka wants to merge 15 commits into
Conversation
added 15 commits
May 15, 2026 16:36
The previous description said 'optimize your repository storage' which was vague and did not reflect the page's actual content. The manage.md page is focused on viewing, filtering, and deleting images and image indexes. Updated the description to accurately reflect this. Fixes docker#25005
The daemon configuration overview only mentioned two methods (JSON file and flags) but was missing the environment variables method via systemd. Added a new section explaining how to use systemd drop-in overrides to set daemon environment variables. Fixes docker#25062
Replace shorthand alias 'docker scout env' with the full canonical command name 'docker scout environment' in the environment integration overview page, matching the CLI reference and cli.md usage. Closes docker#25085
The _index.md page mixed 'docker scout env' and 'docker scout environment' interchangeably. The CLI reference uses 'environment' as the canonical name, so prose references are updated to match. Fixes docker#25085
…ct example Fixes docker#25192 useState was used on line 286 but was missing from the import statement, causing an error if users follow the tutorial literally.
The React code example was using useState, useEffect, and createDockerDesktopClient without importing them, which would cause errors for anyone copy-pasting the snippet. Fixes docker#25192
…rial The createDockerDesktopClient() was declared twice - once at module level (correct) and again inside the App() function (redundant/incorrect). Removed the duplicate declaration inside the function. Fixes docker#25192
The Docker driver page did not mention that multi-platform builds are unsupported, which caused confusion when users encountered runtime errors. Added a Limitations section that clearly states this and links to alternatives. Fixes docker#25044
- Moved Limitations section before Further reading - Corrected multi-platform statement: it depends on the storage driver, not a blanket limitation. Containerd snapshotters (default in Docker Engine v29.x+) support multi-platform builds, while legacy graph-drivers do not. Based on review feedback from thaJeztah.
Fixes docker#25337 - Fix broken sentence in .env file additional information section ('that as' -> 'that are also set as') - Add note clarifying that interpolation precedence is distinct from container environment variable precedence, linking to the dedicated precedence page to reduce confusion
Both cursor.md and droid.md tell users to run `sbx secret set -g cursor` and `sbx secret set -g droid`, but the built-in services table they link to didn't list either service. Fixes docker#25272
Closes docker#25433 The VEX status table only listed 3 of the 4 OpenVEX status values. Added the 'fixed' status with a note that DHI does not use it, linking to the existing explanation section below.
Removes developer-facing TODO comments that were visible in the rendered documentation, flagged by docs-scanner in issue docker#25385.
mohithshuka
requested review from
aevesdocker,
craig-osterhout and
dvdksn
as code owners
❌ Deploy Preview for docsdocker failed. Why did it fail? →
|
github-actions
Bot
added
area/engine
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Removes developer-facing TODO comments that were left visible in the
rendered Docker Agent documentation, as flagged by the docs-scanner
bot in issue #25385.
Changes
content/manuals/ai/docker-agent/rag.md:345— removed inline TODOcomment from inside a NOTE callout block
content/manuals/ai/docker-agent/_index.md:161— removed incompleteTODO link comment
content/manuals/ai/docker-agent/_index.md:167— removed TODOplaceholder comment
Why
TODO comments are developer notes and should never appear in
user-facing documentation. The docs-scanner correctly identified
these as issues.
Testing
Closes #25385