docs: fix outdated content and document missing commands#2600
Merged
Conversation
Spotted while auditing the published documentation against the source. Wrong / outdated information: - Fix the Azure provider env var: the `azure` alias defaults to `AZURE_API_KEY` (see pkg/model/provider/aliases.go), not `AZURE_OPENAI_API_KEY`. Updated the providers overview, models concept page, and troubleshooting cheat sheet. - Fix the GitHub Copilot env var: the alias reads `GITHUB_TOKEN` (a PAT with the `copilot` scope), not `gh auth login`-managed creds. - Fix a broken internal link in providers/openai (`/examples/ websocket_transport/` does not exist as a docs page) — point at the YAML on GitHub instead. - Fix a stray extra column delimiter in the Log Analysis table and a missing word in the Port conflicts section of the troubleshooting page. Missing content: - Add Tasks and Model Picker tools to the navigation; both pages already exist under /tools/ but were not linked from the sidebar. - Document `docker agent serve chat` (OpenAI-compatible Chat Completions server) — the command exists but had no public docs. - Document `docker agent version`. - Document the missing `docker agent run` flags surfaced by cmd/root/run.go and cmd/root/flags.go: `--remote`, `--working-dir`, `--env-from-file`, `--code-mode-tools`, `--models-gateway`, `--fake`, `--record`. - Document the global `--cache-dir`, `--config-dir`, `--data-dir` flags from cmd/root/root.go. - Round out the API-key cheat sheet in the troubleshooting page with Nebius, MiniMax, Requesty, GitHub Copilot, and Azure entries (and note that `GOOGLE_API_KEY` and `GEMINI_API_KEY` are both honored). Assisted-By: docker-agent Signed-off-by: David Gageot <david@gageot.net>
There was a problem hiding this comment.
Assessment: 🟡 NEEDS ATTENTION
This PR fixes several documentation inaccuracies (Azure/GitHub Copilot env vars, broken link, table formatting) and adds missing documentation for new commands and nav entries. The changes are accurate and well-structured. One minor issue found in the newly added content.
|
|
||
| ```bash | ||
| $ docker agent version | ||
| docker agent version v1.54.0 |
There was a problem hiding this comment.
[MEDIUM] Hardcoded version number in example will become stale
The docker agent version example uses a specific real version number (v1.54.0) and commit hash (1737035c). These will be outdated as soon as the next release ships, and users may be confused when their actual output differs from the docs.
Consider using placeholder values instead:
$ docker agent version
docker agent version vX.Y.Z
Commit: <commit-hash>
melmennaoui
approved these changes
Apr 30, 2026
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.
Spotted while auditing the published documentation against the source.
Wrong / outdated information
azurealias defaults toAZURE_API_KEY(seepkg/model/provider/aliases.go), notAZURE_OPENAI_API_KEY. Updated the providers overview, the models concept page, and the troubleshooting cheat sheet.GITHUB_TOKEN(a PAT with thecopilotscope), not "GitHub CLI auth (gh auth login)". The dedicatedproviders/github-copilotpage already documents this correctly; the overview tables now match.docs/providers/openai/index.mdlinked to/examples/websocket_transport/, which doesn't exist as a docs page. Linked the YAML on GitHub instead.Missing content
Tasks(/tools/tasks/) andModel Picker(/tools/model-picker/) pages exist but were never linked from the Built-in Tools navigation. Added them.docker agent serve chat— this command (an OpenAI-compatible Chat Completions server at/v1/chat/completionsand/v1/models) was not documented anywhere despite being a real, shipped command. Added a section in the CLI reference with the full flag table and acurlexample.docker agent version— added a short section in the CLI reference.docker agent runflags — surfaced fromcmd/root/run.goandcmd/root/flags.go:--remote,--working-dir,--env-from-file,--code-mode-tools,--models-gateway,--fake,--record.--cache-dir,--config-dir,--data-dir(fromcmd/root/root.go) to the Global Flags table.Nebius,MiniMax,Requesty,GitHub Copilot, andAzureentries, and noted thatGOOGLE_API_KEYandGEMINI_API_KEYare both honored.Files changed
Docs-only — no Go changes, no behavior changes.