Skip to content

Commit 838d759

Browse files
committed
[memory-bank] Update rules to lay out the "components" structure
Tool: gitpod/catfood.gitpod.cloud
1 parent f752519 commit 838d759

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

memory-bank/.clinerules

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,11 +73,31 @@ This file captures important patterns, preferences, and project intelligence tha
7373
- **README.md**: Each component should have a README explaining its purpose
7474
- **API Documentation**: Generated from Protocol Buffer definitions
7575
- **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.
7682

7783
## Evolution of Project Decisions
7884

7985
This section will be updated as I learn about how and why certain architectural and design decisions were made.
8086

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+
81101
## User Preferences
82102

83103
This section will be updated as I learn about specific user preferences for working with the codebase.

0 commit comments

Comments
 (0)