docs: refresh outdated examples, missing env vars, and CLI options#2610
Open
dgageot wants to merge 1 commit intodocker:mainfrom
Open
docs: refresh outdated examples, missing env vars, and CLI options#2610dgageot wants to merge 1 commit intodocker:mainfrom
dgageot wants to merge 1 commit intodocker:mainfrom
Conversation
- Update introductory and reference pages (intro, quickstart, concepts, configuration, providers/overview, troubleshooting) to use the current default models (openai/gpt-5-mini and anthropic/claude-sonnet-4-5) instead of the older gpt-4o / claude-sonnet-4-0 examples.
- Fix internal inconsistency on the Anthropic provider page: the inline example used claude-sonnet-4-0 while the Available Models table called claude-sonnet-4-5 the default. The page now leads with claude-sonnet-4-5 and keeps claude-sonnet-4-0 in the table as a 'previous Sonnet generation, still supported' entry.
- Configuration Overview: complete the API-key environment-variable table (added GEMINI_API_KEY, MINIMAX_API_KEY, REQUESTY_API_KEY, AZURE_API_KEY, GITHUB_TOKEN for Copilot, AWS_BEARER_TOKEN_BEDROCK), add a new 'Runtime overrides' table that documents DOCKER_AGENT_DEFAULT_MODEL, DOCKER_AGENT_MODELS_GATEWAY and DOCKER_AGENT_HIDE_TELEMETRY_BANNER, and call out the legacy CAGENT_* aliases.
- CLI Reference: add the missing --hide-tool-results option in the alias-options bullet list and mention the legacy CAGENT_MODELS_GATEWAY env var alias next to --models-gateway.
- Troubleshooting: fix the outdated context-window claim ('Claude 200K, Gemini 2M') and refresh the model-name examples.
- Installation: fix a column-alignment glitch in the API-keys block, note that GOOGLE_API_KEY and GEMINI_API_KEY are interchangeable, and link out to the full env-var reference.
Assisted-By: docker-agent
|
Все вірно |
derekmisler
approved these changes
May 1, 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
3 participants
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.
What this PR fixes
A pass through the docs surfaced a handful of issues that were either outdated, wrong, or simply missing. This PR brings the most-read pages back in sync with the codebase.
Outdated model examples
Most introductory pages still showed
openai/gpt-4o/anthropic/claude-sonnet-4-0everywhere, even thoughpkg/config/auto.goand the README itself default toopenai/gpt-5-miniandanthropic/claude-sonnet-4-5. Updated:getting-started/{introduction,quickstart,installation}concepts/{agents,multi-agent,models,distribution}configuration/{overview,agents,routing}providers/{overview,openai,anthropic}community/troubleshootingInternally-inconsistent Anthropic page
docs/providers/anthropic/index.mdhadclaude-sonnet-4-0in the inline / named-model examples while the Available Models table calledclaude-sonnet-4-5the default. The page now leads withclaude-sonnet-4-5and keepsclaude-sonnet-4-0in the table as a previous Sonnet generation, still supported entry.Missing environment variables
docs/configuration/overview/index.mdonly listed 6 of the 11 supported provider keys and didn't mention several runtime env vars at all. Added:GEMINI_API_KEYpkg/model/provider/gemini/client.goMINIMAX_API_KEY,REQUESTY_API_KEYpkg/model/provider/aliases.goAZURE_API_KEYpkg/model/provider/aliases.goGITHUB_TOKEN(Copilot)pkg/model/provider/aliases.goAWS_BEARER_TOKEN_BEDROCKDOCKER_AGENT_DEFAULT_MODELcmd/root/flags.go(envDefaultModel)DOCKER_AGENT_HIDE_TELEMETRY_BANNERcmd/root/root.goDOCKER_AGENT_MODELS_GATEWAY--models-gateway, now also in the env-var tableA short callout points readers at the legacy
CAGENT_*aliases that the same code paths still accept.CLI Reference gaps
docker agent alias addsupports--hide-tool-results(seecmd/root/alias.go) but the Alias Options bullet list didn't mention it.--models-gatewaynow also notes the legacyCAGENT_MODELS_GATEWAYenv var alias.Troubleshooting nits
gpt-4vsgpt-4o; updated togpt-5-mini/gpt-4o.How to verify
No source code is touched, so existing tests and
mise lintare unaffected.