Skip to content

Commit 04c2bf8

Browse files
committed
docs: add two-path navigation (Intuition + Templates) to pattern README
- Add "How to Use This Documentation" section explaining learning paths - Update pattern table with direct links to intuition.md and templates.md - Apply to sliding_window, two_pointers, and backtracking_exploration
1 parent 6904dd5 commit 04c2bf8

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

docs/patterns/README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,27 @@ This directory contains comprehensive documentation for each **API Kernel** and
77

88
---
99

10+
## How to Use This Documentation
11+
12+
Each pattern provides **two learning paths** to help you master the concepts:
13+
14+
| Path | Purpose | Best For |
15+
|------|---------|----------|
16+
| 💡 **Intuition** | Understand the "why" through stories and visual explanations | First-time learners, building mental models |
17+
| 🛠️ **Templates** | Copy-paste ready code with problem-specific variations | Interview prep, quick reference |
18+
19+
**Recommended approach**: Start with Intuition to build understanding, then use Templates for implementation.
20+
21+
---
22+
1023
## Available Pattern Guides
1124

12-
| API Kernel | Document | Description | Problems |
13-
|------------|----------|-------------|----------|
14-
| `SubstringSlidingWindow` | [sliding_window.md](sliding_window.md) | Dynamic window over sequences | LeetCode 3, 76, 159, 209, 340, 438, 567 |
15-
| `TwoPointersTraversal` | [two_pointers.md](two_pointers.md) | Two pointer traversal patterns | LeetCode 1, 11, 15, 16, 21, 26, 27, 75, 88, 125, 141, 142, 167, 202, 283, 680, 876 |
25+
| API Kernel | Learning Resources | Description | Problems |
26+
|------------|-------------------|-------------|----------|
27+
| `SubstringSlidingWindow` | 💡 [Intuition](sliding_window/intuition.md) · 🛠️ [Templates](sliding_window/templates.md) | Dynamic window over sequences | LeetCode 3, 76, 159, 209, 340, 438, 567 |
28+
| `TwoPointersTraversal` | 💡 [Intuition](two_pointers/intuition.md) · 🛠️ [Templates](two_pointers/templates.md) | Two pointer traversal patterns | LeetCode 1, 11, 15, 16, 21, 26, 27, 75, 88, 125, 141, 142, 167, 202, 283, 680, 876 |
29+
| `BacktrackingExploration` | 💡 [Intuition](backtracking_exploration/intuition.md) · 🛠️ [Templates](backtracking_exploration/templates.md) | Exhaustive search with pruning | LeetCode 39, 40, 46, 47, 51, 77, 78, 79, 90, 93, 131, 216 |
1630
| `GridBFSMultiSource` | *coming soon* | Multi-source BFS on grids | LeetCode 994, 286, 542 |
17-
| `BacktrackingExploration` | [backtracking_exploration.md](backtracking_exploration.md) | Exhaustive search with pruning | LeetCode 39, 40, 46, 47, 51, 77, 78, 79, 90, 93, 131, 216 |
1831
| `KWayMerge` | *coming soon* | Merge K sorted sequences | LeetCode 23, 21, 88 |
1932
| `BinarySearchBoundary` | *coming soon* | Binary search boundaries | LeetCode 4, 33, 34, 35 |
2033
| `LinkedListInPlaceReversal` | *coming soon* | In-place linked list reversal | LeetCode 25, 206, 92 |

0 commit comments

Comments
 (0)