david/pi-loop
Watch
1
0
Fork
You've already forked pi-loop
 0
Code Issues 20 Pull requests 1 Projects Releases Packages Wiki Activity Actions

issue-277: reconcile error.json kind enum across DESIGN/IMPLEMENTATION_PLAN/README with DOMAIN.md #278

Merged
david merged 1 commit from documentation/issue-277/reconcile-error-json-kind-enum-docs into main 2026-08-18 07:14:29 +00:00
Conversation 0 Commits 1 Files changed 3 +3 -3
david commented 2026-08-18 07:13:59 +00:00
Owner
Copy link

What & why

DESIGN.md, IMPLEMENTATION_PLAN.md, and README.md documented the error.json kind enum as:

config|auth|not-found|rate-limit|transient|network|agent-failure|git|unknown

missing auto-merge-timeout and auto-merge-failed. These two kinds are pre-existing valid ErrorKind values (from the --auto-merge feature, PR #39) and are already supported by the code (src/orchestrator/types/orchestrator.ts, src/artifacts/helpers/validateErrorReport.ts) and already documented in DOMAIN.md's error.json kind glossary row.

Issue-267's remediate stage fixed the DOMAIN.md row (adding network, auto-merge-timeout, auto-merge-failed) in response to a review finding, but only touched DOMAIN.md — leaving DESIGN.md, IMPLEMENTATION_PLAN.md, and README.md inconsistent (they had network from 267's stage-1 commit, but never got the auto-merge kinds).

This PR brings all three docs in line with DOMAIN.md and the code, so the error.json kind enum is documented consistently everywhere:

config|auth|not-found|rate-limit|transient|network|agent-failure|git|auto-merge-timeout|auto-merge-failed|unknown

Per-file breakdown

  • Modified DESIGN.md — added auto-merge-timeout|auto-merge-failed to the error.json kind example (§ artifact schemas).
  • Modified IMPLEMENTATION_PLAN.md — same addition to the matching error.json kind example.
  • Modified README.md — same addition to the matching error.json kind example (Error Handling section).

Docs-only change; no code or test changes required.

Closes #277

## What & why DESIGN.md, IMPLEMENTATION_PLAN.md, and README.md documented the `error.json` `kind` enum as: ``` config|auth|not-found|rate-limit|transient|network|agent-failure|git|unknown ``` missing `auto-merge-timeout` and `auto-merge-failed`. These two kinds are pre-existing valid `ErrorKind` values (from the `--auto-merge` feature, PR #39) and are already supported by the code (`src/orchestrator/types/orchestrator.ts`, `src/artifacts/helpers/validateErrorReport.ts`) and already documented in `DOMAIN.md`'s `error.json kind` glossary row. Issue-267's remediate stage fixed the DOMAIN.md row (adding `network`, `auto-merge-timeout`, `auto-merge-failed`) in response to a review finding, but only touched DOMAIN.md — leaving DESIGN.md, IMPLEMENTATION_PLAN.md, and README.md inconsistent (they had `network` from 267's stage-1 commit, but never got the auto-merge kinds). This PR brings all three docs in line with DOMAIN.md and the code, so the `error.json` `kind` enum is documented consistently everywhere: ``` config|auth|not-found|rate-limit|transient|network|agent-failure|git|auto-merge-timeout|auto-merge-failed|unknown ``` ## Per-file breakdown - **Modified** `DESIGN.md` — added `auto-merge-timeout|auto-merge-failed` to the `error.json` `kind` example (§ artifact schemas). - **Modified** `IMPLEMENTATION_PLAN.md` — same addition to the matching `error.json` `kind` example. - **Modified** `README.md` — same addition to the matching `error.json` `kind` example (Error Handling section). Docs-only change; no code or test changes required. Closes #277
david self-assigned this 2026-08-18 07:13:59 +00:00
david merged commit 86e9042cd4 into main 2026-08-18 07:14:29 +00:00
david deleted branch documentation/issue-277/reconcile-error-json-kind-enum-docs 2026-08-18 07:14:29 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels   
batch

   
bug

   
chore
Maintenance tasks, cleanup, housekeeping

  
documentation

   
enhancement

   
pi-loop

   
ready

   
resume
No labels
batch
bug
chore
documentation
enhancement
pi-loop
ready
resume
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
david
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
david/pi-loop!278
No description provided.