summaryrefslogtreecommitdiff
path: root/llm/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'llm/README.md')
-rw-r--r--llm/README.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/llm/README.md b/llm/README.md
new file mode 100644
index 0000000..16c8f5b
--- /dev/null
+++ b/llm/README.md
@@ -0,0 +1,41 @@
+# LLM Notes Folder
+
+This folder is for comprehensive notes taken by AI agents after each major change to the codebase.
+
+## Purpose
+- Document learnings, insights, and decisions made during development
+- Track architectural changes, bug fixes, and feature implementations
+- Provide context for future agents or developers
+- Maintain a knowledge base of the project's evolution
+
+## Guidelines for Agents
+- Create a new markdown file for each major change (e.g., `2025-01-07-feature-x.md`)
+- Include: what was changed, why, challenges faced, solutions, and lessons learned
+- Be thorough but concise; aim for 200-500 words per note
+- Use consistent naming: `YYYY-MM-DD-brief-description.md`
+- Reference related files, commits, or issues
+
+## Template
+```
+# [Change Title]
+
+## Summary
+Brief overview of the change.
+
+## What Was Changed
+Detailed description of modifications.
+
+## Why This Change
+Rationale and benefits.
+
+## Challenges & Solutions
+Problems encountered and how they were resolved.
+
+## Learnings
+Key insights, best practices discovered, or future considerations.
+
+## Related
+- Files: list
+- Commits: hash
+- Issues: links
+``` \ No newline at end of file