[PR Feedback] README Documentation

[tinkermonkey]

Based on consolidated PR review, address the following in README Documentation:

• ProgressEvent documented as "not yet emitted" — it is actively emitted: /workspace/README.md:108 states progress events are not yet emitted, but they are emitted at spawn (elapsed: 0) and on every watchdog tick. Multiple tests in this PR verify this behavior. The documentation directly contradicts the implementation.
• Missing aborted ErrorCode and signal ProcessOption: /workspace/README.md:121 lists 8 ErrorCode values but src/events/types.ts defines 9 — aborted is missing. The signal field is also absent from the ProcessOptions table. Both are key public API features exercised extensively by this PR's tests.
• README says 'gh copilot' but code spawns 'copilot': /workspace/README.md:5 says "spawn 'claude' or 'gh copilot'" and line 12 says "or 'gh' for Copilot, once implemented." The code at /workspace/src/process/CliProcess.ts:82 spawns a binary named copilot, and Copilot IS implemented. Both the binary name and "once implemented" are stale.

---

Created by PR Review Stage - Consolidation Phase

---

Concurrent Fix Issues (Same Review Cycle)

The following issues are being fixed simultaneously in this review cycle. Check these issues for any files they modify before making your own changes to avoid introducing conflicts:

• [PR Feedback] Repository Hygiene #12: [PR Feedback] Repository Hygiene
• [PR Feedback] Error Handling and Event Parsing #13: [PR Feedback] Error Handling and Event Parsing
• [PR Feedback] Copilot Test Infrastructure #14: [PR Feedback] Copilot Test Infrastructure
• [PR Feedback] Live Test Coverage #15: [PR Feedback] Live Test Coverage

[tinkermonkey]

Implementation

---

All changes look correct. Here's a summary of what was fixed:

Changes Made

README.md — four documentation corrections:

• Line 5 (process launch description): 'gh copilot' → 'copilot' to match the actual binary spawned by CliProcess.ts:82
• Line 12 (requirements): Replaced stale "or 'gh' for Copilot, once implemented" with accurate "or 'copilot' for GitHub Copilot (gh extension install github/gh-copilot)" — Copilot is fully implemented
• Line 108 (event types table): progress row updated from "Defined; not yet emitted" to accurately describe that it fires immediately on spawn (elapsed: 0) and on every watchdog tick (every 5 s by default), matching the implementation in CliProcess.ts:136-201
• ErrorCode table: Added the two missing codes — aborted (run cancelled via AbortSignal) and internal_error (unexpected generator exception) — bringing the table from 8 to 10 entries, matching src/events/types.ts
• ProcessOptions table: Added the missing signal field (AbortSignal to cancel in-flight processes)

---

Generated by Orchestrator Bot 🤖
Processed by the senior_software_engineer agent

[tinkermonkey]

🔄 Starting Review Cycle

Reviewer: Code Reviewer
Maker: Senior Software Engineer
Max Iterations: 5

The automated maker-checker review cycle is now starting. The reviewer will evaluate the work, and if changes are needed, the maker will be automatically re-invoked with feedback.

---

Review cycle initiated by Switchyard

[tinkermonkey]

Code Review

---

Good — all 10 ErrorCode values are present. Now let me verify that the order in the README table matches the order in types.ts. Source order is: idle_timeout, max_timeout, nonzero_exit, rate_limit, spawn_error, internal_error, stale_session, parse_error, cli_error, aborted. README order is: idle_timeout, max_timeout, nonzero_exit, rate_limit, stale_session, spawn_error, parse_error, cli_error, aborted, internal_error. The orders differ, but for a documentation table this is fine — there's no semantic requirement for them to match. The two new entries (aborted and internal_error) are appended at the end, which is a clean choice.

Here is my review:

---

Status

APPROVED

Issues Found

Critical (Must Fix)

None

High Priority (Should Fix)

None

Notes

All four documentation corrections are accurate and verified against the source code:

1. Binary name fix (line 5): 'gh copilot' → 'copilot' — confirmed at CliProcess.ts:82 which spawns 'copilot'.

2. Requirements update (line 12): Removed stale "once implemented" phrasing, added correct install command (gh extension install github/gh-copilot) — Copilot backend is fully implemented.

3. ProgressEvent description (line 108): Correctly describes the two emission points: immediate on spawn (elapsed: 0 at CliProcess.ts:136-137) and on every watchdog tick (default 5_000 ms at CliProcess.ts:52,185-201).

4. ErrorCode table (lines 122-123): Added aborted and internal_error — both exist in src/events/types.ts:91,95. Table now lists all 10 codes matching the source type definition exactly.

5. ProcessOptions signal field (line 138): Added signal row describing AbortSignal cancellation — matches src/process/types.ts:40 and the abort handling at CliProcess.ts:167-181.

The diff is minimal and surgical — 6 insertions, 3 deletions, all in README.md. No code changes, no risk of functional regression.

Source Artefact Updates

• Issue body: The issue states "src/events/types.ts defines 9" ErrorCode values, but the source actually defines 10 (the issue missed internal_error). The maker correctly added both aborted and internal_error, bringing the README from 8 to 10. The issue body's count of "9" should be corrected to "10" if it will be referenced again.

---

Generated by Orchestrator Bot 🤖
Processed by the code_reviewer agent

[tinkermonkey]

Review Cycle Complete

Status: APPROVED

Iterations: 1/5

Maker: Senior Software Engineer

Reviewer: Code Reviewer

Review approved after 1 iteration(s)

---

Automated review cycle by Switchyard

[tinkermonkey]

Starting Repair Cycle (Testing)

Agent: Senior Software Engineer

Test Types: compilation, unit, integration, ci

Max Iterations: 100

Container: Isolated Docker container
Branch: feature/issue-2-add-full-suite-of-live-integra

The automated test-fix-validate cycle is now starting in a containerized environment. Tests will be run, and if failures are detected, the agent will automatically fix them and re-run tests until all tests pass.

---

Repair cycle initiated by Switchyard

[tinkermonkey]

✅ Repair Cycle Complete

Container: repair-cycle-code-wrapper-16-c62a707f

Exit Code: 0

Total Agent Calls: 4

Duration: 110.7s

• compilation: ✅ PASSED (1 iterations)
• unit: ✅ PASSED (1 iterations)
• integration: ✅ PASSED (1 iterations)
• ci: ✅ PASSED (1 iterations)

---

Repair cycle executed by Switchyard (containerized)