Repository navigation
docs: README was stale across two releases — scout/integrator, agy and Cursor pins - #14
Merged
Merged
Conversation
…pins The README had drifted across two releases and one cell had been wrong since v0.7.0. v0.12.0 added the optional scout and integrator roles; the README did not mention either one anywhere. Now documented where they belong: a Roles table giving each role's write capability and purpose, the measured rationale for why the two optional ones exist (52% of the orchestrator's result bytes went on reading and searching by hand; 727 git calls and 185 gate calls across 30 audited sessions), both questions in the install walkthrough, and both in the architecture sketch. v0.13.0 made agy's model pin required and enforced required pins for every dispatched role rather than coders only. The agent table said agy's pin was optional; it also said Cursor's was optional, which has been wrong since v0.7.0, and omitted that Hermes can review. Every mapped row in that table is now checked against installer/registry.json. Also adds a sixth entry to the properties section for the antigravity-native completion gap, since a reader hitting a hung dispatch needs that on the way past, and indexes the three docs/ files the index was missing. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Both were sitting untracked in the repo root. This file's own header says it is kept as a guard against accidental adds of machine-local things, and an OS metadata file and an editor's local config are exactly that. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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.
The README had drifted across two releases, and one cell had been wrong since v0.7.0. Every claim it makes about the agent catalog is now checked against
installer/registry.jsonrather than by eye.v0.12.0's roles were undocumented
scoutandintegratorshipped in v0.12.0 and appeared in the README zero times — not in the agent table, not in the architecture sketch, not in the install walkthrough, not anywhere. A reader had no way to learn the roles existed, let alone why.Now:
### Rolestable giving each of the five roles its write capability, whether it is required, and what it is for;+ optional:tier rather than by widening the ASCII art;v0.13.0's pin changes, and one older error
The agent table said Antigravity's model pin was
optional. It isrequiredas of v0.13.0 — and an unpinnedagyresolves to no model and dies on launch, so that cell was actively misleading.Checking the whole table against the registry turned up two more:
optionaland has beenrequiredsince v0.7.0 — five releases stale. With no pin the id passed is the orchestrator's, whichcursor-agentrejects (Cannot use this model) and exits 1.Since every agent in the catalog gained
scoutandintegrator, repeating those in all thirteen rows would have been noise — the table now states it once above and the Roles column carries only what distinguishes the agents.Step 4 of the walkthrough also said pins are picked "per coder". They are per worker, and
validate()now refuses a blank where the row requires one, in any role.A sixth property
The properties section gains the
antigravity-nativecompletion gap: a dispatch produces its answer and then sitsstatus: runningforever, because the harness scrapes an interactive TUI that has no completion marker — while already writingactive_turn_id: nullto its own state file. That belongs in the README rather than only indocs/, because a reader meeting a hung dispatch needs it on the way past. The workaround it points at is load-bearing right now: the cross-vendor review of the change that introduced it was recovered exactly that way.Docs index
Was missing
STATS.md,CMDCODE.mdandANTIGRAVITY-NATIVE-COMPLETION.md, all three of which the prose already links to inline.Verification
python3 -m pytest -q→ 279 passed (docs-only change; no code touched).installer/registry.jsonformodel.requiredand thereviewerrole — all agree.docs/links resolve to real files; the[Roles](#roles)anchor has its heading.Note on sequencing
This should land before the v0.13.0 tag, so the release ships documentation that describes it. Tagging first would publish a release whose README is wrong about its own headline feature.
🤖 Generated with Claude Code