docs(readme): the four commands to learn first never said who their output is for

[joyful-ii-V-I]

The Quickstart's four commands to learn first (--max-tokens=3000, --for, --callers, --test-gate) print compact XML sized for an agent's context window, not a page written for people. Nothing near them said so. A reader running them in a terminal could reasonably wonder whether the output is broken.

This adds one note directly under that block:

Written for your agent. Every command prints compact XML sized for an AI agent to read, not for a person scanning a terminal. Human-readable output is on the roadmap.

• Scope: the change is additive. Two lines are inserted, and nothing else in the README moves.
• No conflict with docs(readme): a reader who only wanted the manual had no reference to jump to #192: docs(readme): a reader who only wanted the manual had no reference to jump to #192 adds lines near the top and at the bottom, and this note sits in the Quickstart, so the two merge cleanly.
• Verification: every gate that reads README.md passes (gates=27 pass=27 skip=0 fail=0), and gatecount_build --check returns 0.

🤖 Generated with Claude Code

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Advanced

Run ID: 588dde48-b846-4fc7-9013-d9cce86c85eb

📥 Commits

Reviewing files that changed from the base of the PR and between 9560169 and 0b52d5f.

📒 Files selected for processing (1)

• README.md

Included review availability: Your plan provides up to 4 included reviews per hour; 0 remain after this review.

---

📝 Summary

Summary by CodeRabbit

• Documentation
  • Added a Quickstart note explaining that command output is currently formatted as compact XML for AI-agent consumption.
  • Clarified that human-readable output is planned for a future update.

Walkthrough

The Quickstart section now states that commands print compact XML for AI agents. It also states that human-readable output is planned.

Changes

Quickstart documentation

Layer / File(s)	Summary
Output format note README.md	The Quickstart section documents the compact XML output format and the roadmap for human-readable output.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~2 minutes

Change: Other

Suggested reviewers: quaterniondrift

Merge Risk: ⚪ Minimal · up to 0b52d

The Quickstart note accurately explains the current compact XML output and planned human-readable output.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly identifies the README documentation change and its purpose: clarifying the intended audience for command output.
Description check	✅ Passed	The description directly explains the Quickstart note, its scope, and the verification results. It is fully related to the changeset.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/readme-output-is-for-agents

---

_{Comment @coderabbitai help to get the list of available commands.}