Skip to content

docs: add slice-3 entries to docs/index.md [doc-updater] - #2963

Merged
jwbron merged 1 commit into
mainfrom
egg/doc-update-slice3-index-refs
Jun 3, 2026
Merged

docs: add slice-3 entries to docs/index.md [doc-updater]#2963
jwbron merged 1 commit into
mainfrom
egg/doc-update-slice3-index-refs

Conversation

@james-in-a-box

@james-in-a-box james-in-a-box Bot commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

Update documentation to reflect changes from d117874 (#2949, [issue-2908][slice-3/6] Delta-scoped re-analysis + prompt collapse):

  • 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. This section covers compose_event_prompt, the 10 KB envelope, full git-log delta for adversarial re-review, tail-position memory delivery (od-6 Option B), _build_brc_preamble collapse, and the EGG_BRC_MEMORY mode matrix.
  • Update the Agent Wait Patterns index entry to mention §10.9 (per-event prompt composer + preamble collapse) also added by the slice-3 commit.

The slice-3 code added comprehensive docs to orchestrator.md and agent-wait-patterns.md, but docs/index.md wasn't updated to point to those new sections.

Triggered by: d117874

Test Plan

  • Automated: doc-only change, no code tests
  • Manual: verify index links resolve to correct anchors in orchestrator.md and agent-wait-patterns.md

Authored-by: egg

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

@egg-reviewer egg-reviewer Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 at agent-wait-patterns.md:1411, agent-wait-patterns.md:1662, and brc-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. The 109 prefix 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 from orchestrator.md:1241 and brc-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_preamble collapse" — orchestrator.md:976
  • "EGG_BRC_MEMORY mode 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

@james-in-a-box

This comment has been minimized.

@james-in-a-box

james-in-a-box Bot commented Jun 3, 2026

Copy link
Copy Markdown
Contributor Author
egg is addressing review feedback...

@james-in-a-box

james-in-a-box Bot commented Jun 3, 2026

Copy link
Copy Markdown
Contributor Author

Review Response

Reviewed feedback from egg-reviewer[bot] on the doc-only changes.

Per-item disposition:

  • Anchor verification (both new anchors resolve to existing headings): disagree (no action needed — reviewer confirmed anchors resolve correctly; this is a positive verification, not a request for change)
  • Description accuracy (every claim maps to target content): disagree (no action needed — reviewer confirmed description accuracy)
  • Scope (diff matches PR body, no collateral edits): disagree (no action needed — reviewer confirmed scope is appropriate)

The reviewer explicitly stated: "No blocking issues, no non-blocking suggestions." No code changes were made.

— Authored by egg

@james-in-a-box

james-in-a-box Bot commented Jun 3, 2026

Copy link
Copy Markdown
Contributor Author

egg feedback addressed. View run logs

1 previous review(s) hidden.

@jwbron
jwbron merged commit ae72904 into main Jun 3, 2026
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant