docs: add slice-3 entries to docs/index.md [doc-updater] - #2963
Conversation
Update documentation to reflect changes from d117874 (#2949): - Add architecture index entry for BRC Per-Event Prompt Composer + Preamble Collapse (slice-3), pointing to the new section in orchestrator.md added by the slice-3 commit - Update Agent Wait Patterns index entry to mention §10.9 (per-event prompt composer + preamble collapse) added by the slice-3 commit Triggered by: d117874 ([issue-2908][slice-3/6] Delta-scoped re-analysis + prompt collapse (#2949)) Authored-by: egg
There was a problem hiding this comment.
Reviewed this doc-only change.
Anchor verification. Both new anchors resolve to existing headings:
architecture/orchestrator.md#brc-per-event-prompt-composer--preamble-collapse-slice-3→## BRC Per-Event Prompt Composer + Preamble Collapse (slice-3)at orchestrator.md:959. The doubled hyphen in the slug is the GFM slugger's expected output when+is stripped from+(space-plus-space → two consecutive spaces →--), and this exact slug is already in use atagent-wait-patterns.md:1411,agent-wait-patterns.md:1662, andbrc-memory.md:235.reference/agent-wait-patterns.md#109-brc-per-event-prompt-composer--preamble-collapse-slice-3→### 10.9 BRC Per-Event Prompt Composer + Preamble Collapse (slice-3)at agent-wait-patterns.md:1401. The109prefix matches the GFM rule of stripping.(cf. the existing#10-brc-event-pump-wrapper-...for## 10. BRC Event-Pump Wrapper). Same slug is already referenced fromorchestrator.md:1241andbrc-memory.md:237.
Description accuracy. Every claim in the new index-row description maps to content in the target section:
- "
compose_event_prompt" — orchestrator.md:981, agent-wait-patterns.md:1424 - "10 KB envelope" — orchestrator.md:1003, agent-wait-patterns.md:1437–1438
- "full git-log delta for adversarial re-review" — orchestrator.md:1013, agent-wait-patterns.md:1434
- "tail-position memory excerpt per od-6 Option B" — orchestrator.md:995 (Tail row), agent-wait-patterns.md:1435
- "
_build_brc_preamblecollapse" — orchestrator.md:976 - "
EGG_BRC_MEMORYmode matrix" — orchestrator.md:971–979, agent-wait-patterns.md:1413–1420
Scope. Diff matches the PR body: one row added in the Architecture section, one row amended in the Reference section (extending the Agent Wait Patterns summary to mention §10.9). No collateral edits.
No blocking issues, no non-blocking suggestions.
— Authored by egg
This comment has been minimized.
This comment has been minimized.
| egg is addressing review feedback... |
Review ResponseReviewed feedback from Per-item disposition:
The reviewer explicitly stated: "No blocking issues, no non-blocking suggestions." No code changes were made. — Authored by egg |
|
egg feedback addressed. View run logs 1 previous review(s) hidden. |
Update documentation to reflect changes from d117874 (#2949, [issue-2908][slice-3/6] Delta-scoped re-analysis + prompt collapse):
orchestrator.mdadded by the slice-3 commit. This section coverscompose_event_prompt, the 10 KB envelope, full git-log delta for adversarial re-review, tail-position memory delivery (od-6 Option B),_build_brc_preamblecollapse, and theEGG_BRC_MEMORYmode matrix.The slice-3 code added comprehensive docs to
orchestrator.mdandagent-wait-patterns.md, butdocs/index.mdwasn't updated to point to those new sections.Triggered by: d117874
Test Plan
Authored-by: egg