docs: fix hallucinated CLI flags, commands, and config formats#2020
Open
dgageot wants to merge 1 commit intodocker:mainfrom
Open
docs: fix hallucinated CLI flags, commands, and config formats#2020dgageot wants to merge 1 commit intodocker:mainfrom
dgageot wants to merge 1 commit intodocker:mainfrom
Conversation
- Fix Go version prerequisite in contributing docs (1.25 → 1.26) - Remove nonexistent -c flag and --max-tokens flag from CLI docs - Fix handoffs YAML example to use string array instead of object array - Replace /usage with /cost (the actual TUI command) in tips docs Assisted-By: docker-agent
There was a problem hiding this comment.
Review Summary
Assessment: 🟢 APPROVE
Documentation corrections verified
All changes accurately fix documentation to match the actual codebase:
- ✅ Go version updated from 1.25 → 1.26 (verified against go.mod)
- ✅ Removed nonexistent
-c <name>flag (not in CLI definitions) - ✅ Removed nonexistent
--max-tokensflag (not in CLI definitions) - ✅ Fixed
handoffsYAML to use string array format (matches agent-schema.json) - ✅ Updated
/usage→/costcommand (correct TUI command)
No bugs detected. The PR successfully corrects hallucinated documentation to reflect actual implementation.
Review conducted by cagent
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
Fix several documentation inaccuracies where content didn't match the actual codebase.
Changes
go.mod)-c <name>flag and--max-tokensflag--max-tokensflag from examplehandoffsYAML example to use string array (matching schema); replace/usagewith/cost(the actual TUI command)All changes verified against
go.mod,agent-schema.json, and CLI flag definitions incmd/root/.