Skip to content

docs: fix hallucinated CLI flags, commands, and config formats#2020

Open
dgageot wants to merge 1 commit intodocker:mainfrom
dgageot:board/our-documentations-docs-used-to-be-full-0fb55b46
Open

docs: fix hallucinated CLI flags, commands, and config formats#2020
dgageot wants to merge 1 commit intodocker:mainfrom
dgageot:board/our-documentations-docs-used-to-be-full-0fb55b46

Conversation

@dgageot
Copy link
Member

@dgageot dgageot commented Mar 9, 2026

Summary

Fix several documentation inaccuracies where content didn't match the actual codebase.

Changes

  • contributing/index.md: Fix Go version prerequisite (1.25 → 1.26, matching go.mod)
  • features/cli/index.md: Remove nonexistent -c <name> flag and --max-tokens flag
  • getting-started/quickstart/index.md: Remove nonexistent --max-tokens flag from example
  • guides/tips/index.md: Fix handoffs YAML example to use string array (matching schema); replace /usage with /cost (the actual TUI command)

All changes verified against go.mod, agent-schema.json, and CLI flag definitions in cmd/root/.

- 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
@dgageot dgageot requested a review from a team as a code owner March 9, 2026 20:02
Copy link

@docker-agent docker-agent bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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-tokens flag (not in CLI definitions)
  • ✅ Fixed handoffs YAML to use string array format (matches agent-schema.json)
  • ✅ Updated /usage/cost command (correct TUI command)

No bugs detected. The PR successfully corrects hallucinated documentation to reflect actual implementation.


Review conducted by cagent

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant