31 lines
932 B
Plaintext
31 lines
932 B
Plaintext
---
|
|
description: Documentation standards for LabFusion project
|
|
globs: ["**/*.md", "**/*.txt"]
|
|
alwaysApply: true
|
|
---
|
|
|
|
# Documentation Standards
|
|
|
|
When working with documentation files, follow these standards:
|
|
|
|
## Required Documentation Files
|
|
- **Main README**: @README.md
|
|
- **Project Structure**: @docs/structure.txt
|
|
- **Progress Tracking**: @docs/progress.md
|
|
- **Clean Code Guide**: @CLEAN_CODE.md
|
|
|
|
## Service Documentation
|
|
Each service MUST have:
|
|
- **README.md**: Service overview, setup, and usage
|
|
- **CLEAN_CODE.md**: Clean code implementation details
|
|
|
|
## Frontend Documentation
|
|
- **README.md**: @frontend/README.md
|
|
- **Clean Code**: @frontend/CLEAN_CODE.md
|
|
- **Resilience**: @frontend/RESILIENCE.md
|
|
|
|
## Documentation Updates
|
|
- Update @docs/structure.txt when adding new files
|
|
- Update @docs/progress.md when completing tasks
|
|
- Update service READMEs when modifying functionality
|
|
- Keep all documentation current and comprehensive |