11 lines
742 B
Markdown
11 lines
742 B
Markdown
# RULES.md
|
|
|
|
## Foundational Rules
|
|
1. **No documents outside the folder:** All project-related documents and files must reside strictly within this repository folder.
|
|
2. **Keep documentation concise:** Documentation should be brief, clear, and to the point.
|
|
3. **Single source of truth:** Use single, dedicated documents for specific types of information to avoid fragmentation and redundancy.
|
|
- Use `ARCHITECTURE.md` for all architectural information.
|
|
- Use `PLAN.md` for ongoing steps, which must be revised after each PR.
|
|
- Use `COMPONENTS.md` to track all specific components used in the project.
|
|
4. **Document Components After Inclusion:** Only add components to `COMPONENTS.md` once you have actually included them in the code.
|