Skip to content

docs: document consensus wrapper for concurrent agents [doc-updater] - #1099

Merged
jwbron merged 1 commit into
mainfrom
egg/doc-update-consensus-wrapper
Mar 14, 2026
Merged

docs: document consensus wrapper for concurrent agents [doc-updater]#1099
jwbron merged 1 commit into
mainfrom
egg/doc-update-consensus-wrapper

Conversation

@james-in-a-box

Copy link
Copy Markdown
Contributor

Update documentation to reflect changes from #1092 (Enforce consensus protocol for concurrent agents):

  • docs/development/STRUCTURE.md: Add consensus_wrapper.py to 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 in orchestrator/consensus_wrapper.py. Covers: how the wrapper keeps containers alive after Claude exits, the EGG_CONSENSUS_WRAPPER_TIMEOUT env var, and the orchestrator-side implicit READY registration for clean-exiting containers that didn't explicitly signal.

Triggered by: #1092

Issue: none

Test plan:

  • Verify consensus_wrapper.py appears in the STRUCTURE.md orchestrator listing
  • Verify the Consensus Wrapper section appears between Agent Startup Protocol and Message Bus in concurrent-execution.md
  • Verify EGG_CONSENSUS_WRAPPER_TIMEOUT is documented in the new section

Authored-by: egg

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)

@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.

Verified all documentation claims against source code. This is an accurate, well-structured doc update.

Verified:

  • consensus_wrapper.py exists at orchestrator/consensus_wrapper.py and 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_TEMPLATE shell script exactly.
  • Default values: EGG_CONSENSUS_WRAPPER_TIMEOUT=300 and EGG_MESSAGE_POLL_INTERVAL=30 match 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

@james-in-a-box

This comment has been minimized.

@james-in-a-box

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

@james-in-a-box

Copy link
Copy Markdown
Contributor Author

egg feedback addressed. View run logs

1 previous review(s) hidden.

@jwbron
jwbron merged commit bbd5273 into main Mar 14, 2026
22 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