docs: document consensus wrapper for concurrent agents [doc-updater] - #1099
Merged
Conversation
Update docs to reflect changes from #1092: - Add consensus_wrapper.py to STRUCTURE.md orchestrator listing - Document the new shell-level consensus wrapper in concurrent-execution.md: EGG_CONSENSUS_WRAPPER_TIMEOUT env var, auto-READY on clean exit (both wrapper-side and orchestrator-side implicit registration)
Contributor
There was a problem hiding this comment.
Verified all documentation claims against source code. This is an accurate, well-structured doc update.
Verified:
consensus_wrapper.pyexists atorchestrator/consensus_wrapper.pyand the STRUCTURE.md entry is in correct alphabetical order.- Wrapper behavior (auto-signal READY on clean exit, skip on non-zero, poll loop with timeout) matches the
_CONSENSUS_WRAPPER_TEMPLATEshell script exactly. - Default values:
EGG_CONSENSUS_WRAPPER_TIMEOUT=300andEGG_MESSAGE_POLL_INTERVAL=30match the${...:-N}defaults in the script. - Orchestrator-side implicit READY behavior confirmed in
orchestrator/routes/pipelines.py:4710-4730— the_run_concurrent_phase()function auto-registers READY with the exact reason string"Container exited cleanly (implicit READY)"documented here. - Section placement (between Agent Startup Protocol and Message Bus) is logical and matches the execution flow.
No issues found.
Minor note (non-blocking): The EGG_MESSAGE_POLL_INTERVAL env var appears in both the "Environment injection" table (Agent Startup Protocol section) and the new "Environment variables" table (Consensus Wrapper section). This is mild redundancy but acceptable since the Consensus Wrapper section is self-contained and readers may navigate to it directly.
— Authored by egg
This comment has been minimized.
This comment has been minimized.
Contributor
Author
| egg is addressing review feedback... |
Contributor
Author
|
egg feedback addressed. View run logs 1 previous review(s) hidden. |
jwbron
approved these changes
Mar 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Update documentation to reflect changes from #1092 (Enforce consensus protocol for concurrent agents):
docs/development/STRUCTURE.md: Addconsensus_wrapper.pyto the orchestrator structure listing. The new module was omitted from the structure doc.docs/guides/concurrent-execution.md: Add a new Consensus Wrapper section documenting the shell-level safety net introduced inorchestrator/consensus_wrapper.py. Covers: how the wrapper keeps containers alive after Claude exits, theEGG_CONSENSUS_WRAPPER_TIMEOUTenv var, and the orchestrator-side implicit READY registration for clean-exiting containers that didn't explicitly signal.Triggered by: #1092
Issue: none
Test plan:
consensus_wrapper.pyappears in the STRUCTURE.md orchestrator listingEGG_CONSENSUS_WRAPPER_TIMEOUTis documented in the new sectionAuthored-by: egg