Skip to content

docs: update structure and API docs for concurrent messaging [doc-updater]#1034

Open
james-in-a-box[bot] wants to merge 2 commits intomainfrom
egg/doc-update-concurrent-messaging
Open

docs: update structure and API docs for concurrent messaging [doc-updater]#1034
james-in-a-box[bot] wants to merge 2 commits intomainfrom
egg/doc-update-concurrent-messaging

Conversation

@james-in-a-box
Copy link
Contributor

Update documentation to reflect the cross-agent messaging and concurrent phase execution added in #1031.

Three new orchestrator modules (concurrent_executor.py, consensus.py, message_store.py) and a new route module (routes/messages.py) were not reflected in the project structure reference. The orchestrator API endpoint list was also missing the new message bus endpoints and the readiness signal type.

Changes:

  • docs/development/STRUCTURE.md: Add new concurrent execution modules to orchestrator listing; add routes/messages.py; annotate signals.py with readiness signal support
  • docs/architecture/orchestrator.md: Add message bus endpoints (GET|POST /messages, GET /messages/status) and update signal endpoint description to include readiness type

Issue: none

Test plan:

  • Verify new file names match what exists in orchestrator/ on main
  • Verify API endpoints match orchestrator/routes/messages.py and the readiness handling in orchestrator/routes/signals.py

Authored-by: egg

Update documentation to reflect changes from be1de7f:
- Add concurrent_executor.py, consensus.py, message_store.py to
  STRUCTURE.md orchestrator module listing
- Add routes/messages.py to routes listing; annotate signals.py with
  readiness signal support
- Add message bus API endpoints to orchestrator architecture doc
- Update signal endpoint description to include readiness signal type

Triggered by: #1031 (Add cross-agent messaging and concurrent phase execution)

Authored-by: egg
Copy link
Contributor

@egg-reviewer egg-reviewer bot left a comment

Choose a reason for hiding this comment

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

No agent-mode design concerns. This is a documentation-only PR adding file listings and API endpoint references for the concurrent execution feature from #1031.

— Authored by egg

@james-in-a-box

This comment has been minimized.

Copy link
Contributor

@egg-reviewer egg-reviewer bot left a comment

Choose a reason for hiding this comment

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

Verified all claims:

  • concurrent_executor.py, consensus.py, message_store.py, and routes/messages.py all exist on main
  • API endpoints match the actual Flask blueprint routes in routes/messages.py (url_prefix /api/v1/pipelines, routes /<pipeline_id>/messages and /<pipeline_id>/messages/status)
  • readiness signal type is confirmed in routes/signals.py (line 124 dispatch table)

One non-blocking nit:

STRUCTURE.md ordering (docs/development/STRUCTURE.md): concurrent_executor.py and consensus.py are placed between docker_client.py and events.py, but alphabetically they belong between container_monitor.py and dag_visualizer.py (the rest of the list is roughly alphabetical by first letter). message_store.py placement is fine. Suggested order:

├── container_spawner.py
├── container_monitor.py
├── concurrent_executor.py  # moved up — "co" before "d"
├── consensus.py            # moved up — "co" before "d"
├── dag_visualizer.py

(Pre-existing: container_spawner before container_monitor is also out of order, but that's not this PR's problem.)

— Authored by egg

@james-in-a-box

This comment has been minimized.

@james-in-a-box

This comment has been minimized.

Copy link
Contributor Author

@james-in-a-box james-in-a-box bot left a comment

Choose a reason for hiding this comment

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

Agreed. Moved concurrent_executor.py and consensus.py up to their correct alphabetical position after container_monitor.py (7951674).

— Authored by egg

Copy link
Contributor

@egg-reviewer egg-reviewer bot left a comment

Choose a reason for hiding this comment

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

No agent-mode design concerns. Delta since last review is a single commit (7951674) fixing alphabetical ordering in STRUCTURE.md — no design-relevant changes.

— Authored by egg

Copy link
Contributor

@egg-reviewer egg-reviewer bot left a comment

Choose a reason for hiding this comment

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

Re-review after feedback-addressing commit (7951674).

Previous feedback addressed: The alphabetical ordering of concurrent_executor.py and consensus.py in STRUCTURE.md has been fixed correctly. They now sit after container_monitor.py and before dag_visualizer.py, consistent with the surrounding alphabetical order.

No new issues introduced. The change is a clean two-line move with no content modifications.

All file references verified against main: concurrent_executor.py, consensus.py, message_store.py, routes/messages.py — all exist. API endpoints and descriptions remain accurate.

— Authored by egg

@james-in-a-box

This comment has been minimized.

@james-in-a-box

This comment has been minimized.

@james-in-a-box
Copy link
Contributor Author

egg is addressing review feedback...

@james-in-a-box
Copy link
Contributor Author

egg feedback addressed. View run logs

5 previous review(s) hidden.

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