docs(readme): make architecture diagram render legibly - #3
Merged
Conversation
The architecture diagram used flowchart LR with ~10 multi-line nodes plus a subgraph, so GitHub rendered it very wide and scaled it down until the text was unreadable. Switch to top-down (TD) and lay the four showrunner brain nodes out in a compact row (subgraph direction LR + invisible links) so it renders narrow and legible. Diagram content unchanged.
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.
What
The README architecture diagram was authored as
flowchart LRwith ~10 multi-line nodes and a subgraph. GitHub renders wide Mermaid diagrams by scaling them down to the column width, which shrank the text until it was unreadable.Change
flowchart TD) so it renders as a narrow, readable column instead of an oversized horizontal strip.showrunnerbrain nodes in a single compact row (direction LR+ invisible~~~links inside the subgraph) so the diagram stays short.TDand renders fine — left unchanged.Diagram content is unchanged; this is a layout-only fix. Verified by rendering both diagrams locally with mermaid-cli.
Fix by Ralu