-
Notifications
You must be signed in to change notification settings - Fork 2
Open
Labels
documentationIndicates that a PR includes changes to documentationIndicates that a PR includes changes to documentation
Milestone
Description
Summary
Remove the Mermaid sequence diagrams from the four subpackage READMEs under wool/src/wool/runtime/ and create a single comprehensive sequence diagram in the top-level wool/README.md.
The subpackage READMEs that currently contain sequence diagrams:
wool/src/wool/runtime/worker/README.md— Worker execution sequencewool/src/wool/runtime/loadbalancer/README.md— Load balancing sequencewool/src/wool/runtime/routine/README.md— Routine dispatch sequencewool/src/wool/runtime/discovery/README.md— Discovery sequence
Motivation
The individual diagrams each document one layer of the runtime in isolation. A single consolidated diagram in the top-level README gives readers a complete picture of Wool's distributed task execution flow — from routine invocation through discovery, load balancing, worker dispatch, and result return — without having to navigate into subpackage directories and mentally stitch the pieces together.
Affected code
wool/README.mdwool/src/wool/runtime/worker/README.mdwool/src/wool/runtime/loadbalancer/README.mdwool/src/wool/runtime/routine/README.mdwool/src/wool/runtime/discovery/README.md
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationIndicates that a PR includes changes to documentationIndicates that a PR includes changes to documentation