diff --git a/docs/index.md b/docs/index.md index 00504b590f..9d586a3aad 100644 --- a/docs/index.md +++ b/docs/index.md @@ -32,7 +32,7 @@ This index helps both humans and LLMs navigate the documentation efficiently. | [Why egg Works](architecture/collaboration-effectiveness.md) | How the public, sandboxed, async model delivers safety and collaboration | | [Integration-Test Trust Boundary](architecture/integration-test-trust-boundary.md) | Test execution contexts (in-sandbox-agent / trusted-CI-runner / human-operator) and fixture tiers; authoritative reference for plan-phase Trust-Boundary Audit (#2594) | | [BRC Memory Artifact](architecture/brc-memory.md) | Per-role-per-pipeline distilled memory file written by `brc_ack`/`brc_nack`; schema, three `EGG_BRC_MEMORY` modes, atomic-write contract, fail-closed path constructor, distill-on-write cap at 20, and role-allowlist coverage ([#2908](https://github.com/jwbron/egg/issues/2908) slice-1) | -| [Served Coordination State](architecture/coordination-state.md) | Three-clause invariant retiring ad-hoc git/prompt choreography for pipeline coordination state: (1) served reads for everything an agent consumes but doesn't own, (2) harness-performed deterministic sync where a real checkout is needed, (3) one artifact spec from which validation, the read API, and prompt text derive. Mechanism map (`read_peer_artifact`, wrapper `sync_to_proposals` + NOT-synced banner, `artifact_spec`, `/api/v1/artifact/get` strict by name, no-sync-mechanics ratchet), `_clear_concurrent_state()` designed phase-boundary wipe vs accidental mid-phase memory-backend loss, and the [#3002](https://github.com/jwbron/egg/issues/3002) unblocking note ([#3077](https://github.com/jwbron/egg/issues/3077)) | +| [Served Coordination State](architecture/coordination-state.md) | Three-clause invariant retiring ad-hoc git/prompt choreography for pipeline coordination state: (1) served reads for everything an agent consumes but doesn't own, (2) harness-performed deterministic sync where a real checkout is needed, (3) one artifact spec from which validation, the read API, and prompt text derive. Mechanism map (`read_peer_artifact`, wrapper `sync_to_proposals` + NOT-synced banner, `artifact_spec`, `/api/v1/artifact/get` strict by name, no-sync-mechanics ratchet), `_clear_concurrent_state()` designed phase-boundary wipe (accidental mid-phase memory-backend loss retired with [#3159](https://github.com/jwbron/egg/issues/3159) Redis-only removal), and the [#3002](https://github.com/jwbron/egg/issues/3002) unblocking note ([#3077](https://github.com/jwbron/egg/issues/3077)) | | [BRC Consensus Wrapper](architecture/orchestrator.md#brc-consensus-wrapper) | Deterministic event-pump wrapper loop (default on since slice-4); wrapper-side heartbeat + gateway-session keep-alive; idle/no-progress safety budget replacing the 3-restart FAIL cap. Wait-side companion: [agent-wait-patterns §10](reference/agent-wait-patterns.md#10-brc-consensus-wrapper-event-pump-model) ([#2908](https://github.com/jwbron/egg/issues/2908) slices 1–4) | | [BRC Per-Event Prompt Composer + Preamble Collapse](architecture/orchestrator.md#brc-per-event-prompt-composer--preamble-collapse-slice-3) | Per-event prompt assembled by `compose_event_prompt` (10 KB envelope, full git-log delta for adversarial re-review, tail-position memory excerpt per od-6 Option B); `_build_brc_preamble` collapse; `EGG_BRC_MEMORY` mode matrix. Wait-side companion: [agent-wait-patterns §10.9](reference/agent-wait-patterns.md#109-brc-per-event-prompt-composer--preamble-collapse-slice-3) ([#2908](https://github.com/jwbron/egg/issues/2908) slice-3) |