Skip to content

Add orchestrator docs + state machine diagram to README.md#172

Closed
albertywu wants to merge 1 commit into
mainfrom
wua/orchestrator-state-machine-diagram
Closed

Add orchestrator docs + state machine diagram to README.md#172
albertywu wants to merge 1 commit into
mainfrom
wua/orchestrator-state-machine-diagram

Conversation

@albertywu
Copy link
Copy Markdown
Contributor

@albertywu albertywu commented Jun 2, 2026

Summary

Add orchestrator docs + state machine diagram to README.md

stateDiagram-v2
    [*] --> start: land request (from gateway)

    start --> validate: request persisted, URIs claimed
    validate --> batch: validated (not duplicate, mergeable)
    batch --> score: grouped into batch
    score --> speculate: batch scored

    speculate --> build: start speculation
    build --> buildsignal: build triggered
    buildsignal --> speculate: build result received

    speculate --> merge: dependencies succeeded
    merge --> speculate: re-plan dependents

    merge --> conclude: merged (success or conflict)
    speculate --> conclude: dependency failed / self-heal

    conclude --> [*]: request Landed / Error

    start --> log: audit event (async)
    score --> log: audit event (async)
    log --> [*]
Loading

Copilot AI review requested due to automatic review settings June 2, 2026 02:26
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a Mermaid state machine diagram and accompanying notes to the orchestrator README, documenting the pipeline of queues and how stages publish to one another.

Changes:

  • Replaces a single-line README with a structured document describing the orchestrator pipeline.
  • Adds a Mermaid stateDiagram-v2 showing transitions across start, validate, batch, score, speculate, build, buildsignal, merge, conclude, and log.
  • Adds notes explaining feedback loops, self-healing, and the async log sink.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@albertywu albertywu changed the title add orchestrator state machine diagram to README.md Add orchestrator docs + state machine diagram to README.md Jun 2, 2026
@albertywu albertywu marked this pull request as ready for review June 2, 2026 03:47
@albertywu albertywu requested review from a team, behinddwalls and sbalabanov as code owners June 2, 2026 03:47
Copy link
Copy Markdown
Collaborator

@behinddwalls behinddwalls left a comment

Choose a reason for hiding this comment

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

I believe this is captured in docs/workflow.md file

@albertywu
Copy link
Copy Markdown
Contributor Author

I believe this is captured in docs/workflow.md file

ACK, will close this one out.

@albertywu albertywu closed this Jun 2, 2026
@albertywu albertywu deleted the wua/orchestrator-state-machine-diagram branch June 2, 2026 18:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants