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

documentation: document ADR-019 docs-scope fatal preflight in README #291

Merged
david merged 1 commit from documentation/2026-08-19/adr-019-preflight-readme-note into main 2026-08-19 04:25:51 +00:00
Conversation 0 Commits 1 Files changed 1 +7 -1
david commented 2026-08-19 04:25:41 +00:00
Owner
Copy link

Summary

Commits a missed README.md update that documents the ADR-019 docs-scope fatal
preflight (checkDocsScopeIgnored). The content was originally produced by
the docs stage during run 20260819T023108Z-286 but never made it into a
commit — that same run hit the exact bug ADR-019 fixes (a local
.git/info/exclude entry covering docs/ made the docs stage's git add
fail atomically), and while runDocsGit's discard-on-failure guard almost
certainly reverted the working tree cleanly at the end of that run, the
edit was reintroduced into this local clone by unrelated activity afterward
and never got committed.

What changed

  • README.md:
    • Prerequisites: added the new requirement that no in-scope doc file
      may be covered by a git ignore source when the docs stage is enabled,
      noting the --no-docs escape hatch.
    • Error-handling policy: documented the new fail-fast docs-scope
      preflight, run before any agent session starts.

Verification

  • Content cross-checked against already-shipped ADR-019 references in
    AGENTS.md and DESIGN.md — consistent with both.
  • No code changes; documentation-only PR.

Related

  • ADR-019 (shipped in
    a separate PR alongside the other previously-uncommitted docs).
  • Issue #286 / PR #289 (the fatal preflight implementation this documents).
## Summary Commits a missed README.md update that documents the ADR-019 docs-scope fatal preflight (`checkDocsScopeIgnored`). The content was originally produced by the docs stage during run `20260819T023108Z-286` but never made it into a commit — that same run hit the exact bug ADR-019 fixes (a local `.git/info/exclude` entry covering `docs/` made the docs stage's `git add` fail atomically), and while `runDocsGit`'s discard-on-failure guard almost certainly reverted the working tree cleanly at the end of that run, the edit was reintroduced into this local clone by unrelated activity afterward and never got committed. ## What changed - `README.md`: - **Prerequisites**: added the new requirement that no in-scope doc file may be covered by a git ignore source when the docs stage is enabled, noting the `--no-docs` escape hatch. - **Error-handling policy**: documented the new fail-fast docs-scope preflight, run before any agent session starts. ## Verification - Content cross-checked against already-shipped ADR-019 references in `AGENTS.md` and `DESIGN.md` — consistent with both. - No code changes; documentation-only PR. ## Related - [ADR-019](docs/adr/019-fatal-docs-scope-ignore-preflight.md) (shipped in a separate PR alongside the other previously-uncommitted docs). - Issue #286 / PR #289 (the fatal preflight implementation this documents).
david merged commit bcb29530d2 into main 2026-08-19 04:25:51 +00:00
david deleted branch documentation/2026-08-19/adr-019-preflight-readme-note 2026-08-19 04:25:51 +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
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!291
No description provided.