Skip to content

Fix the doc-drift cluster from the 2026-08-08 audit - #387

Merged
TheGreatAxios merged 6 commits into
mainfrom
cl-5667-doc-drift-cluster
Aug 8, 2026
Merged

Fix the doc-drift cluster from the 2026-08-08 audit#387
TheGreatAxios merged 6 commits into
mainfrom
cl-5667-doc-drift-cluster

Conversation

@TheGreatAxios

Copy link
Copy Markdown
Collaborator

Summary

  • PRODUCT.md's stall section described a hard abort with an error string that doesn't exist in src/; rewritten to match the real auto-pause/resume behavior in model-family-policy.ts, consistent with ARCHITECTURE.md.
  • ARCHITECTURE.md's permission section now points at the one queued-gate gap that's still live (gate-wire.ts timers arming at emit instead of display, and ask_operator's missing timeout safety net) instead of describing the whole mechanism as working. Two of the three disconnects an earlier audit found are already fixed and merged (project-grant cwd matching, grant-driven queue reconciliation), so those aren't called out.
  • ARCHITECTURE.md's Events table retitled to what it actually is (the two turn-boundary/shutdown events the directors guard on) and both it and IMPLEMENTATION.md now point at PRODUCTION_REACTOR_TYPES in stream-event-map.ts as the one canonical event list, instead of maintaining two different partial ones.
  • IMPLEMENTATION.md's docs/ file index was missing TUI.md, TELEMETRY.md, PERFTRACE.md; fixed to match reality. AGENTS.md's Reference table now mentions docs/plans/ so an agent following its own "read /docs first" instruction can find it.

Test plan

  • Docs-only change; verified no remaining references to the removed error string anywhere in the tree
  • Verified current main state of the three permission-system bugs cited by the audit (two merged, one still open) before writing the ARCHITECTURE.md callout

@linear-code

linear-code Bot commented Aug 8, 2026

Copy link
Copy Markdown

CL-5667

The doc described a hard abort at 3 idle turns with a specific error
string that does not exist in src/. The real mechanism auto-pauses
(not aborts) at a model-family-dependent tool-only-turn threshold and
resumes on the next operator message, matching what ARCHITECTURE.md's
"Main-session loop protection" section already describes correctly.
The section described the permission system as fully wired. Two of
the three disconnects an earlier design review found (project-grant
cwd matching, grant-driven queue reconciliation) are already fixed
and merged, so this only calls out what remains live: queued-gate
timers arm at emit time instead of display time, and ask_operator has
no timeout/abort safety net, both in gate-wire.ts.
…rface

The three-row table only ever named the two events the turn-boundary
guards care about, but its heading and placement read as an
enumeration of the reactor's event vocabulary — and IMPLEMENTATION.md
kept a second, differently partial list with no cross-reference.
Retitle the table, point both docs at PRODUCTION_REACTOR_TYPES in
stream-event-map.ts as the one canonical list, and drop
IMPLEMENTATION.md's separate enumeration.
IMPLEMENTATION.md's File Structure section listed six of the nine
docs/ files, missing TUI.md, TELEMETRY.md, and PERFTRACE.md.
Separately, docs/plans/ holds design-decision write-ups (including the
current authoritative source on live permission-system gaps) but
wasn't mentioned anywhere in AGENTS.md's Reference table, so an agent
following AGENTS.md's own "read /docs first" instruction had no way to
discover it.
…nter

Greybeard and Critique both caught the same defect: the new prose
claimed the table names "only the two events reactor-events.ts guards
for" while the table itself still had three rows, including tool.done
(which reactor-events.ts doesn't guard). Rewrote the prose to say why
tool.done is there instead of asserting a count the table contradicts.
Also corrected the PRODUCTION_REACTOR_TYPES line citation, carried
over wrong from the audit doc (66-80 -> 62-78 in both ARCHITECTURE.md
and IMPLEMENTATION.md).
The pause text in PRODUCT.md and ARCHITECTURE.md was a paraphrase presented
as a quotation; it never matched director.ts. The hardcoded "15 types" count
would drift the same way the lists this PR replaced did.
@TheGreatAxios
TheGreatAxios force-pushed the cl-5667-doc-drift-cluster branch from 654f0eb to 0430ee6 Compare August 8, 2026 19:06
@TheGreatAxios
TheGreatAxios merged commit dbfb4e7 into main Aug 8, 2026
3 checks passed
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