docs: add visual pattern map with Mermaid diagrams #3463
docs: add visual pattern map with Mermaid diagrams #3463dadhich-ashish wants to merge 4 commits intoiluwatar:masterfrom
Conversation
PR SummaryAdds a complete visual reference of all design patterns organized by category (Mermaid diagrams) with a new PATTERNS.md and updated README surface Pattern Map linking to the visual reference. Changes
autogenerated by presubmit.ai |
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
🚨 Pull request needs attention.
Review Summary
Commits Considered (1)
- 4cff57d: docs: adding pattern visual for initial users and understanding
Files Processed (2)
- PATTERNS.md (1 hunk)
- README.md (1 hunk)
Actionable Comments (2)
-
PATTERNS.md [13-14]
readability: "Mermaid syntax: root label on a single line"
-
README.md [67-68]
readability: "Mermaid syntax: root label on a single line"
Skipped Comments (0)
PATTERNS.md
Outdated
| root((Design Patterns | ||
| 153 total)) |
There was a problem hiding this comment.
Mermaid mindmap root label is split across two lines, which breaks the diagram syntax. Put the entire label on a single line, e.g., root((Design Patterns 153 total)).
README.md
Outdated
| root((Design Patterns | ||
| 153 total)) |
There was a problem hiding this comment.
Mermaid mindmap root label is split across two lines in the README as well. Fix to a single line to ensure the diagram renders.
There was a problem hiding this comment.
🚨 Pull request needs attention.
Review Summary
Commits Considered (1)
- e373299: docs: fix line break comment given by github-action[bot] https://github.com/iluwatar/java-design-patterns/pull/3463/changes#r3043458599
Files Processed (2)
- PATTERNS.md (1 hunk)
- README.md (1 hunk)
Actionable Comments (1)
-
PATTERNS.md [12-16]
possible bug: "Total count mismatch between catalog and per-category counts."
Skipped Comments (2)
-
README.md [68-72]
possible bug: "Pattern count mismatch in README Pattern Map."
-
PATTERNS.md [11-12]
enhancement: "Mermaid mindmap compatibility note."
| mindmap | ||
| root((Design Patterns 153 total)) | ||
| Creational | ||
| 18 patterns | ||
| Object creation |
There was a problem hiding this comment.
Total patterns count is inconsistent: the header claims 153 total patterns, but the per-category counts shown here sum to 152. Please reconcile the counts so the total matches the sum of categories, and ensure PATTERNS.md and the README Pattern Map reflect the same total.
There was a problem hiding this comment.
✅ LGTM!
Review Summary
Commits Considered (1)
- b53696c: Merge branch 'master' into patterns-visual
Files Processed (1)
- README.md (1 hunk)
Actionable Comments (0)
Skipped Comments (2)
-
README.md [50-91]
readability: "Mermaid mindmap syntax reliability in README"
-
README.md [48-49]
maintainability: "Verify PATTERNS.md exists and link accuracy"
There was a problem hiding this comment.
✅ LGTM!
Review Summary
Commits Considered (1)
- 112b05c: docs: fix count of patterns, reviewed by github-actions
Files Processed (2)
- PATTERNS.md (1 hunk)
- README.md (1 hunk)
Actionable Comments (0)
Skipped Comments (3)
-
PATTERNS.md [13-13]
possible bug: "Pattern total consistency"
-
PATTERNS.md [302-302]
compatibility: "Mermaid compatibility risk"
-
README.md [46-46]
maintainability: "Documentation alignment"
|
1 participant
Adds a visual overview of all 153 design patterns organized by category, making it easier for newcomers to understand the breadth and structure of the repository at a glance.