Skip to content

docs: update slice-dag and orchestrator-cli for #2399/#2403/#2410 [doc-updater] - #2425

Merged
jwbron merged 1 commit into
mainfrom
egg/doc-update-slice-branch-restart-2399
May 6, 2026
Merged

docs: update slice-dag and orchestrator-cli for #2399/#2403/#2410 [doc-updater]#2425
jwbron merged 1 commit into
mainfrom
egg/doc-update-slice-branch-restart-2399

Conversation

@james-in-a-box

@james-in-a-box james-in-a-box Bot commented May 6, 2026

Copy link
Copy Markdown
Contributor

Update documentation to reflect changes from a505cfa (PR #2402):

Triggered by: #2402

Test Plan

  • Automated: no code changes; documentation only.
  • Manual: verify the updated branch shape and EGG_SLICE_ID descriptions match the implementation in orchestrator/routes/pipelines.py (_ensure_pipeline_work_ref) and sandbox/egg_agent_tools/handlers/brc.py (_maybe_attach_slice_id).

Authored-by: egg

…c-updater]

Update documentation to reflect changes from a505cfa:
- slice-dag.md: document that the pipeline tip is now at egg/<id>/work
  (not egg/<id>) so slice integration branches can coexist as siblings
  (#2399); update branch table, get_slice_integration_branch note, and
  get_worktree_branch example accordingly.
- slice-dag.md: EGG_SLICE_ID is no longer just an advisory hint — BRC
  handlers now read it and attach slice_id to every CONSENSUS_* payload
  so the orchestrator routes to the per-slice tracker (#2403).
- slice-dag.md: remove restart_agent with slice_id from "Out of scope"
  — the REST endpoint now accepts ?slice_id=slice-N (#2410).
- orchestrator-cli.md: add slice-scoped curl example to the agent
  restart note.

Triggered by: #2402

Authored-by: egg

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

No agent-mode design concerns — documentation-only PR updating descriptions of branch namespace, slice-scoped signal routing, and a restart_agent curl example. No prompts, agent surface, or control-flow changes to assess.

— Authored by egg

@james-in-a-box

This comment has been minimized.

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

Approve — documentation-only update; all three claims verified against the implementation

This PR updates slice-dag.md and orchestrator-cli.md to reflect three landed changes (#2399, #2403, #2410). I verified each claim against the current code:

1. egg/<id>/work branch namespace (#2399)

_ensure_pipeline_work_ref in orchestrator/routes/pipelines.py:682-726 performs the documented normalisation (egg/<id>egg/<id>/work, idempotent on egg/<id>/work, structural ≥2-slash check so egg/work deepens to egg/work/work). The "directory file conflict" rationale added to the get_slice_integration_branch paragraph matches the constraint the helper guards against.

2. slice_id attachment to CONSENSUS_* payloads (#2403)

sandbox/egg_agent_tools/handlers/brc.py:26-41 defines _maybe_attach_slice_id, which reads slice_id from the request or falls back to get_slice_id() (the EGG_SLICE_ID reader) and validates against slice-<N> before attaching. It is called from all 5 BRC signal handlers (lines 444, 529, 586, 634, 754). The previous slice-dag.md text describing EGG_SLICE_ID as "an advisory hint" is genuinely stale; the new wording is accurate. The cross-reference to peer_consensus._tracker_key is correct — orchestrator/peer_consensus.py:1834 composes {pipeline_id}/{slice_id} when slice_id is supplied.

3. restart_agent with slice_id (#2410)

orchestrator/routes/pipelines.py:2262-2338 exposes the documented surface — slice_id accepted via query string with body fallback (query param wins, both validated through extract_slice_id). The "Out of scope" list edit in slice-dag.md correctly removes restart_agent with slice_id and notes the landing PRs. The new curl example in orchestrator-cli.md:211 is well-formed (URL is quoted, which is needed for the ? query separator).

Other observations

  • No new code; no test plan beyond manual doc/code cross-check is appropriate here.
  • Heading levels, table formatting, and link targets unchanged outside the edited regions.
  • The _run_concurrent_phase paragraph's mention that _handle_brc_consensus_timeout still receives slice_id is preserved verbatim — good, since that wiring is unchanged.

Nothing blocking, no non-blocking suggestions.

— Authored by egg

@james-in-a-box

james-in-a-box Bot commented May 6, 2026

Copy link
Copy Markdown
Contributor Author

egg review completed. View run logs

1 previous review(s) hidden.

@jwbron
jwbron merged commit c0bd849 into main May 6, 2026
29 checks passed
james-in-a-box Bot pushed a commit that referenced this pull request May 6, 2026
…i.md

Kept HEAD's babysit-pr branch shape correction (egg/babysit-pr/{pr}/{short-sha}/{role})
in slice-dag.md per bb47b84 — verified against orchestrator/concurrent_executor.py:257.
Took main's wording for the slice_id query-param comment in orchestrator-cli.md
(equivalent meaning, established by #2425).
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