Open
Conversation
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
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.
Add Mermaid overview diagrams to each pattern category in README
Summary
This PR adds three lightweight Mermaid diagrams to
README.md— one per pattern category (Creational, Structural, Behavioral) — to give readers a quick visual orientation before they dive into the pattern tables.Closes / related to: Issue #468
Motivation
The README is an excellent reference, but it is primarily textual. For learners encountering design patterns for the first time, a compact visual overview significantly reduces the cognitive load of figuring out how patterns in the same group relate to each other. This is a well-documented pedagogical benefit: visual representations of abstract relationships improve comprehension and recall.
The Mermaid diagrams on GitHub render natively (no external tooling required), so this is a zero-dependency improvement.
What changed
README.md— three diagram blocks inserted, one before each pattern table:Each diagram block is:
```mermaid ```fenced code blockDesign decisions
Why
graph LR/graph TDand not class or sequence diagrams?Flowcharts render cleanly in GitHub's built-in Mermaid renderer and are the most broadly understood diagram type. Class diagrams would require defining attributes/methods per node, which would make the diagrams noisy and harder to scan at a glance.
Why keep diagrams simple?
The detailed implementation already lives in each
.pyfile. The diagrams are meant to answer "what role does this group play?", not "how does every pattern work?".Screenshots
Diagrams render natively in GitHub — no action needed. You can preview them by pasting the blocks into mermaid.live.
Checklist
.pysource files or testsREADME.mdonly — no new files added