docs: link on-demand agent lifecycle doc from README and arch overview [doc-updater] - #3204
Merged
Merged
Conversation
…w [doc-updater] Update documentation to reflect changes from #3181 (slice-3 of #3064): - docs/architecture/README.md: add event_loop.py and supervision_policy.py to the Multi-Agent Orchestration components row; add On-Demand Agent Lifecycle to the Key Architectural Decisions list - README.md: add on-demand-agent-lifecycle.md link alongside orchestrator.md in the documentation table Triggered by: #3181 Authored-by: egg
This comment has been minimized.
This comment has been minimized.
Contributor
There was a problem hiding this comment.
Approve. Doc-only change. I traced every claim in the diff against the repo and everything resolves correctly.
Verification performed
Link targets exist and resolve:
docs/architecture/on-demand-agent-lifecycle.mdexists (12.8 KB). The new link inREADME.mduses the repo-root-relative pathdocs/architecture/on-demand-agent-lifecycle.md✓; the link indocs/architecture/README.mduses the same-directory relative pathon-demand-agent-lifecycle.md✓.- All four files listed in the Multi-Agent Orchestration components row exist:
concurrent_executor.py,kubernetes_spawner.py, and the two newly-addedevent_loop.py+supervision_policy.py.
Descriptions are accurate, not aspirational:
JobSupervisorreferenced in the arch-README description is a real class (orchestrator/event_loop.py:237), wired in via slice-3 as the body states.- The "streak/backoff/alert via shared
supervision_policy.py" claim matches the source:SUPERVISION_BACKOFF_FACTOR=2,_CAP_SECONDS=30,_STREAK_WARN=5,_STREAK_ALERT=10, consistent with the doc's own supervision table (streak × 2 s, capped 30 s, sticky alert at ≥10).
No duplication / scope is correct:
- The doc was already linked from
docs/index.md:35(pre-existing, untouched). This PR correctly adds only the two locations that were missing —README.mdanddocs/architecture/README.md— matching the body's claim that the doc "was not yet linked from" those two files.
Markdown integrity: both edited table rows retain correct column counts; the ·-separated multi-link cells follow the existing convention already used in the same tables (e.g. the "Non-Claude model routing" row).
No blocking or non-blocking issues found.
— Authored by egg
Contributor
Author
|
egg review completed. View run logs 1 previous review(s) hidden. |
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 #3181 (slice-3 of #3064):
Slice-3 wired
JobSupervisorinto the orchestrator event loop and addedorchestrator/supervision_policy.pyas the single source of truth for supervision constants (backoff factor, cap, warn/alert thresholds). These files are now part of the Multi-Agent Orchestration component. A companion architecture doc,on-demand-agent-lifecycle.md, was added in this set but was not yet linked fromdocs/architecture/README.mdorREADME.md.Changes:
docs/architecture/README.md: addevent_loop.pyandsupervision_policy.pyto the Multi-Agent Orchestration components row; add On-Demand Agent Lifecycle to the Key Architectural Decisions listREADME.md: addon-demand-agent-lifecycle.mdlink alongsideorchestrator.mdin the documentation tableTriggered by: #3181
Test Plan
Authored-by: egg