Skip to content

Commit 8040add

Browse files
committed
memory-bank update
- 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
1 parent 5414595 commit 8040add

File tree

5 files changed

+417
-469
lines changed

5 files changed

+417
-469
lines changed

.clinerules/learning-journal.md

Lines changed: 0 additions & 152 deletions
This file was deleted.

.clinerules/memory-bank.md

Lines changed: 28 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ I am Cline, an expert software engineer with a unique characteristic: my memory
44

55
## Memory Bank Structure
66

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:
88

99
```mermaid
1010
flowchart TD
1111
PB[projectbrief.md] --> PC[productContext.md]
1212
PB --> SP[systemPatterns.md]
1313
PB --> TC[techContext.md]
14-
PB --> CI[components/_index.md]
14+
PB --> CI[components.md]
1515
1616
PC --> AC[activeContext.md]
1717
SP --> AC
@@ -39,12 +39,15 @@ flowchart TD
3939
- Recent changes
4040
- Next steps
4141
- Active decisions and considerations
42+
- Learnings and project insights
4243

4344
4. `systemPatterns.md`
4445
- System architecture
4546
- Key technical decisions
4647
- Design patterns in use
4748
- Component relationships
49+
- Critical implementation paths
50+
- Important patterns and preferences
4851

4952
5. `techContext.md`
5053
- Technologies used
@@ -57,19 +60,14 @@ flowchart TD
5760
- What's left to build
5861
- Current status
5962
- Known issues
63+
- Evolution of project decisions
6064

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.
7371

7472
### Additional Context
7573
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:
7977
- Testing strategies
8078
- Deployment procedures
8179

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+
8286
## Core Workflows
8387

8488
### Plan Mode
8589
```mermaid
8690
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?}
9093
9194
CheckFiles -->|No| Plan[Create Plan]
9295
Plan --> Document[Document in Chat]
@@ -99,11 +102,9 @@ flowchart TD
99102
### Act Mode
100103
```mermaid
101104
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]
107108
Execute --> Document[Document Changes]
108109
```
109110

@@ -121,18 +122,17 @@ flowchart TD
121122
122123
subgraph Process
123124
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]
128128
129-
P1 --> P2 --> P3 --> P4 --> P5
129+
P1 --> P2 --> P3 --> P4
130130
end
131131
132132
Start --> Process
133133
```
134134

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.
136136

137137
## Memory Management
138138
- Be mindful of space in memory bank files
@@ -150,38 +150,6 @@ When compressing memory bank files:
150150
4. Distill important insights into long-term memory
151151
5. Delete outdated or redundant information
152152

153-
## Project Intelligence (.clinerules/learning-journal.md)
154-
155-
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-
185153
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.
186154

187155
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

Comments
 (0)