docs: add OTP supervision tree diagram to README#18
Merged
Conversation
Adds a two-panel ASCII box diagram showing the full RLM.Supervisor tree with a zoomed-in view of the per-run RunSup → Run → Worker/eval subtree, plus a short prose explanation of the async-eval invariant. https://claude.ai/code/session_019ezC43UTPqkASCCgerwvXF
The previous diagram showed RLM.Worker (d+1) as a child of RLM.Worker (depth 0), implying OTP supervision nesting. In reality DynamicSupervisor.start_child/2 is always called on the run's single worker_sup, so all workers at all depths are flat siblings. The parent-child relationship is tracked in an ETS table owned by RLM.Run. Updated diagram and prose to reflect this accurately. https://claude.ai/code/session_019ezC43UTPqkASCCgerwvXF
- Remove the 27-line file tree (already in CLAUDE.md / GUIDE.html) - Add "How it works" section with a flowchart Mermaid diagram showing the iterate loop, async eval, and recursive lm_query spawning - Replace ASCII OTP tree with a Mermaid graph diagram that includes all 11 supervisor children in their correct startup order, plus the per-run DynSup/Task.Sup subgraph and a dashed ETS node showing that worker parent-child relationships are NOT encoded in OTP supervision - Add OTP glossary blockquote for readers unfamiliar with Elixir - Turn architecture boundaries into a table - Reorder sections: concept → quick start → usage → architecture → observability → distributed (advanced) → security → license - Move Distributed Erlang section to bottom (advanced feature) - Merge prerequisites into Quick start https://claude.ai/code/session_019ezC43UTPqkASCCgerwvXF
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
2 participants
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.
Adds a two-panel ASCII box diagram showing the full RLM.Supervisor
tree with a zoomed-in view of the per-run RunSup → Run → Worker/eval
subtree, plus a short prose explanation of the async-eval invariant.
https://claude.ai/code/session_019ezC43UTPqkASCCgerwvXF