You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- drop learning-journal.md (too heavy, never used)
- re-align memory-bank with default (to some degree)
- moved components/_index.md to components.md
- updated components.md content to make it more suitable for key-word search
Copy file name to clipboardExpand all lines: .clinerules/memory-bank.md
+28-60Lines changed: 28 additions & 60 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,14 +4,14 @@ I am Cline, an expert software engineer with a unique characteristic: my memory
4
4
5
5
## Memory Bank Structure
6
6
7
-
The Memory Bank consists of required core files and optional context files, all in Markdown format. Files build upon each other in a clear hierarchy:
7
+
The Memory Bank consists of core files and optional context files, all in Markdown format. Files build upon each other in a clear hierarchy:
8
8
9
9
```mermaid
10
10
flowchart TD
11
11
PB[projectbrief.md] --> PC[productContext.md]
12
12
PB --> SP[systemPatterns.md]
13
13
PB --> TC[techContext.md]
14
-
PB --> CI[components/_index.md]
14
+
PB --> CI[components.md]
15
15
16
16
PC --> AC[activeContext.md]
17
17
SP --> AC
@@ -39,12 +39,15 @@ flowchart TD
39
39
- Recent changes
40
40
- Next steps
41
41
- Active decisions and considerations
42
+
- Learnings and project insights
42
43
43
44
4.`systemPatterns.md`
44
45
- System architecture
45
46
- Key technical decisions
46
47
- Design patterns in use
47
48
- Component relationships
49
+
- Critical implementation paths
50
+
- Important patterns and preferences
48
51
49
52
5.`techContext.md`
50
53
- Technologies used
@@ -57,19 +60,14 @@ flowchart TD
57
60
- What's left to build
58
61
- Current status
59
62
- Known issues
63
+
- Evolution of project decisions
60
64
61
-
7.`components/_index.md`
62
-
- Comprehensive index of all components
63
-
- Brief descriptions of component functionality
64
-
- Key relationships between components
65
-
- Entry point for exploring component-specific documentation
66
-
67
-
### Per-component Documentation
68
-
- The `memory-bank/components/_index.md` file provides a comprehensive index of all components with brief descriptions
69
-
- The `memory-bank/components` directory contains detailed documentation about each component
70
-
-**Always read the components/_index.md file** at the start of every task to understand the component landscape
71
-
- Use the index as a starting point to identify which component documentation files to read in depth
72
-
- With regards to maintaining and updating it, treat it just like any other part of the memory-bank
65
+
7.`components.md`
66
+
-**Master index** for the per-component documentation in the `memory-bank/components/` directory
67
+
- Provides **keywords** for each component to facilitate searching for relevant detailed documentation
68
+
- Lists key components with direct links to their individual markdown files
69
+
- Serves as the primary entry point for discovering and navigating to **per-component documentation files**.
70
+
-**Instruction:** Use this index to search for keywords to identify specific component documentation files to read in depth.
73
71
74
72
### Additional Context
75
73
Create additional files/folders within memory-bank/ when they help organize:
@@ -79,14 +77,19 @@ Create additional files/folders within memory-bank/ when they help organize:
79
77
- Testing strategies
80
78
- Deployment procedures
81
79
80
+
#### Per-component Documentation
81
+
- The `memory-bank/components/` directory houses individual Markdown files containing detailed documentation for each component
82
+
- The main `memory-bank/components.md` file acts as a comprehensive **index** to these per-component files
83
+
- It includes keywords and direct links, and you **MUST use this index to search for keywords to identify the specific component documentation files to read in depth**
84
+
- These individual component documents, as well as the main `components.md` index, should be updated whenever necessary
85
+
82
86
## Core Workflows
83
87
84
88
### Plan Mode
85
89
```mermaid
86
90
flowchart TD
87
-
Start[Start] --> ReadFiles[Read Core Memory Bank Files]
88
-
ReadFiles --> ReadIndex[Read Components Index]
89
-
ReadIndex --> CheckFiles{Files Complete?}
91
+
Start[Start] --> ReadFiles[Read Memory Bank]
92
+
ReadFiles --> CheckFiles{Files Complete?}
90
93
91
94
CheckFiles -->|No| Plan[Create Plan]
92
95
Plan --> Document[Document in Chat]
@@ -99,11 +102,9 @@ flowchart TD
99
102
### Act Mode
100
103
```mermaid
101
104
flowchart TD
102
-
Start[Start] --> Context[Read Core Memory Bank Files]
103
-
Context --> ReadIndex[Read Components Index]
104
-
ReadIndex --> Update[Update Documentation]
105
-
Update --> Rules[Update .clinerules/learning-journal.md if needed]
106
-
Rules --> Execute[Execute Task]
105
+
Start[Start] --> Context[Check Memory Bank]
106
+
Context --> Update[Update Documentation]
107
+
Update --> Execute[Execute Task]
107
108
Execute --> Document[Document Changes]
108
109
```
109
110
@@ -121,18 +122,17 @@ flowchart TD
121
122
122
123
subgraph Process
123
124
P1[Review ALL Files]
124
-
P2[Review Components Index]
125
-
P3[Document Current State]
126
-
P4[Clarify Next Steps]
127
-
P5[Update .clinerules/learning-journal.md]
125
+
P2[Document Current State]
126
+
P3[Clarify Next Steps]
127
+
P4[Document Insights & Patterns]
128
128
129
-
P1 --> P2 --> P3 --> P4 --> P5
129
+
P1 --> P2 --> P3 --> P4
130
130
end
131
131
132
132
Start --> Process
133
133
```
134
134
135
-
Note: When triggered by **update memory bank**, I MUST review every memory bank file, even if some don't require updates. Focus particularly on activeContext.md, progress.md, and components/_index.md as they track current state and component relationships.
135
+
Note: When triggered by **update memory bank**, I MUST review every memory bank file, even if some don't require updates. Focus particularly on activeContext.md, progress.md, and **memory-bank/components.md** as they track current state and component relationships.
136
136
137
137
## Memory Management
138
138
- Be mindful of space in memory bank files
@@ -150,38 +150,6 @@ When compressing memory bank files:
150
150
4. Distill important insights into long-term memory
The .clinerules/learning-journal.md file is my learning journal for each project. It captures important patterns, preferences, and project intelligence that help me work more effectively. As I work with you and the project, I'll discover and document key insights that aren't obvious from the code alone.
156
-
157
-
```mermaid
158
-
flowchart TD
159
-
Start{Discover New Pattern}
160
-
161
-
subgraph Learn [Learning Process]
162
-
D1[Identify Pattern]
163
-
D2[Validate with User]
164
-
D3[Document in .clinerules/learning-journal.md]
165
-
end
166
-
167
-
subgraph Apply [Usage]
168
-
A1[Read .clinerules/learning-journal.md]
169
-
A2[Apply Learned Patterns]
170
-
A3[Improve Future Work]
171
-
end
172
-
173
-
Start --> Learn
174
-
Learn --> Apply
175
-
```
176
-
177
-
### What to Capture
178
-
- Critical implementation paths
179
-
- User preferences and workflow
180
-
- Project-specific patterns
181
-
- Known challenges
182
-
- Evolution of project decisions
183
-
- Tool usage patterns
184
-
185
153
The format is flexible - focus on capturing valuable insights that help me work more effectively with you and the project. Think of in .clinerules/learning-journal.md as a living document that grows smarter as we work together.
186
154
187
155
REMEMBER: After every memory reset, I begin completely fresh. The Memory Bank is my only link to previous work. It must be maintained with precision and clarity, as my effectiveness depends entirely on its accuracy.
0 commit comments