initializing the code rules

This commit is contained in:
2026-02-03 20:58:00 -06:00
commit a2a06d28c7
5 changed files with 213 additions and 0 deletions

30
SUPPORTING_DOCS.md Normal file
View File

@@ -0,0 +1,30 @@
# Supporting Documents and Samples
Supporting documents and example documents are provided in folders that begin with `supporting_` in the workspace root folder.
## Purpose
These folders contain reference materials, examples, templates, and documentation that support development but are not part of the active codebase. They provide context, patterns, and samples that help with implementation decisions.
## When to Use
An LLM agent should reference supporting documents when:
- Looking for implementation patterns or examples
- Needing template code or configuration samples
- Understanding architectural decisions or design documents
- Finding API specifications or integration guides
- Reviewing documentation for existing systems or protocols
## Examples of Supporting Documents
- Template configurations
- Code samples and examples
- API documentation
- Architecture diagrams
- Design documents
- Integration guides
- Reference implementations
## How to Reference
When working on tasks that may benefit from supporting documentation, proactively search for relevant `supporting_*` folders and read the relevant files. Use these documents as reference to ensure consistency with existing patterns and approaches.