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
Copy file name to clipboardExpand all lines: memory-bank/.clinerules
+20Lines changed: 20 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -73,11 +73,31 @@ This file captures important patterns, preferences, and project intelligence tha
73
73
- **README.md**: Each component should have a README explaining its purpose
74
74
- **API Documentation**: Generated from Protocol Buffer definitions
75
75
- **Architecture Documentation**: System-level documentation in various formats
76
+
- **Memory Bank Documentation**:
77
+
- Component-specific documentation is stored in `memory-bank/components/` directory
78
+
- Each component gets its own markdown file with detailed information about its purpose, architecture, and implementation
79
+
- API components (with "*-api" suffix) should NOT be documented separately as they are typically just interface definitions
80
+
- Component documentation should focus on the main service components that implement business logic
81
+
- Documentation follows a consistent structure with sections for Overview, Purpose, Architecture, Key Features, etc.
76
82
77
83
## Evolution of Project Decisions
78
84
79
85
This section will be updated as I learn about how and why certain architectural and design decisions were made.
80
86
87
+
### Memory Bank Organization
88
+
89
+
- **Component Documentation**: The decision to create separate documentation files for each component in the `memory-bank/components/` directory was made to:
90
+
1. Provide a clear, organized structure for component documentation
91
+
2. Allow for detailed documentation of each component's purpose, architecture, and implementation
92
+
3. Make it easier to find information about specific components
93
+
4. Enable incremental updates to component documentation without affecting other files
94
+
95
+
- **API Component Exclusion**: The decision to exclude "*-api" components from separate documentation was made because:
96
+
1. API components primarily contain interface definitions, not implementation logic
97
+
2. The interfaces are typically documented within the main service component that implements them
98
+
3. Documenting API components separately would create redundancy
99
+
4. The focus should be on documenting the service components that implement business logic
100
+
81
101
## User Preferences
82
102
83
103
This section will be updated as I learn about specific user preferences for working with the codebase.
0 commit comments