Skip to content

Commit 654f0eb

Browse files
committed
Fix a self-contradiction and a stale citation in the Events table pointer
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).
1 parent 3ee24e1 commit 654f0eb

2 files changed

Lines changed: 14 additions & 11 deletions

File tree

docs/ARCHITECTURE.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,19 @@ The reactor (from `@intx/agent`) drives a single agent turn-by-turn. Each turn i
1414

1515
This repeats until the director emits `capabilities.done()`.
1616

17-
### Events the turn-boundary guards distinguish
18-
19-
This table is not the full reactor/stream event vocabulary — it names only
20-
the two events `src/agent/reactor-events.ts` exports guards for. The
21-
complete set of reactor and stream event types the TUI maps is
22-
`PRODUCTION_REACTOR_TYPES` in `src/tui-opentui/stream-event-map.ts:66-80`
23-
(15 types as of this writing, including `message.received`,
24-
`inference.start`, `inference.text.delta`, `inference.tool_call.start` /
25-
`.delta` / `.end`, `tool.start`, and `connector.reply`) — treat that as
26-
canonical rather than this table or any other doc's partial list.
17+
### Events this section talks about
18+
19+
This table is not the full reactor/stream event vocabulary. `tool.done` is
20+
here because the sub-sections below reference it; `inference.done` and
21+
`reactor.done` are the two events `src/agent/reactor-events.ts` exports
22+
guards for (`onTurnBoundary` / `onReactorShutdown`) — see the paragraph
23+
after the table. The complete set of reactor and stream event types the TUI
24+
maps is `PRODUCTION_REACTOR_TYPES` in
25+
`src/tui-opentui/stream-event-map.ts:62-78` (15 types as of this writing,
26+
including `message.received`, `inference.start`, `inference.text.delta`,
27+
`inference.tool_call.start` / `.delta` / `.end`, `tool.start`, and
28+
`connector.reply`) — treat that as canonical rather than this table or any
29+
other doc's partial list.
2730

2831
| Event | When it fires |
2932
|---|---|

docs/IMPLEMENTATION.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -335,7 +335,7 @@ session; that tree re-write is inherent to git and left as residual cost.
335335
`agent.stream()` emits `ReactorEmittedEvent` objects. `docs/ARCHITECTURE.md`'s
336336
"Events" section names the two turn-boundary/shutdown events the directors
337337
guard on; the full set of reactor and stream event types is
338-
`PRODUCTION_REACTOR_TYPES` in `src/tui-opentui/stream-event-map.ts:66-80`
338+
`PRODUCTION_REACTOR_TYPES` in `src/tui-opentui/stream-event-map.ts:62-78`
339339
treat that as the canonical list rather than maintaining a second one here.
340340

341341
Mid-run queue/steer/interrupt state is a pure state machine in `src/tui-opentui/session-queue.ts` (interaction contract §3): `enqueue` (kind `"queue"`) and `enqueueSteer` (kind `"steer"`) share one pending pool, drained steer-first, then queue, both FIFO within their class. The prompt hint (`src/tui-opentui/stream.ts`, `PROMPT_HINT`) reads `Enter queue · Alt+Enter steer · Ctrl+C stop`.

0 commit comments

Comments
 (0)