docs: sync documentation with recent code changes#2923
Closed
aheritier wants to merge 2 commits into
Closed
Conversation
- Add --app-name, --sidebar, --disable-commands flags to docker agent run table - Add model_id field to after_llm_call hook payload docs - Rename cagent/ meta keys to docker-agent/ in remote-mcp OAuth section
docker-agent
left a comment
docker-agent
left a comment
There was a problem hiding this comment.
Assessment: 🟢 APPROVE
Documentation changes look correct and well-structured. Three doc fixes reviewed:
- CLI flags:
--app-name,--sidebar,--disable-commandsadded consistently with the existing table format ✅ - Hooks payload:
model_idadded toafter_llm_calltable and prose — matches style of surrounding hook event rows ✅ - Remote MCP OAuth meta keys:
cagent/*→docker-agent/*rename is fully applied throughout the unmanaged OAuth flow section, no leftover old keys ✅
One minor wording clarification suggested inline.
| | `--remote <addr>` | Use a remote runtime at the given address instead of running the agent locally | | ||
| | `--lean` | Use a simplified TUI with minimal chrome | | ||
| | `--app-name <name>` | Application name shown in the TUI in place of "docker agent" | | ||
| | `--sidebar` | Show the sidebar in the TUI (set `--sidebar=false` to hide it) | |
There was a problem hiding this comment.
[LOW] --sidebar flag description doesn't state the default value
The current wording — "Show the sidebar in the TUI (set --sidebar=false to hide it)" — leaves readers uncertain whether the sidebar is shown or hidden by default. The phrasing reads as if --sidebar is an opt-in flag (default hidden), yet the parenthetical about --sidebar=false implies the flag is boolean with a default of true.
Consider making the default explicit, e.g.:
Show the sidebar in the TUI; enabled by default (pass --sidebar=false to hide it)
aheritier
added
area/cli
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
2 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.
Three doc fixes to sync with recent code changes:
docs/features/cli/index.md): add--app-name,--sidebar, and--disable-commandsto thedocker agent runflag table, grouped with the other TUI-related flags.docs/configuration/hooks/index.md): addmodel_idto theafter_llm_callevent table and prose description (PR fix(runtime): populate ModelID in after_llm_call hook payload #2911).docs/features/remote-mcp/index.md): renamecagent/type,cagent/server_url,cagent/authorize_url,cagent/state→docker-agent/*in the unmanaged OAuth flow section (commits dfca23c, 6dd7608).