From a9f315490bae09e9ae801e94b12b055ca596cf5c Mon Sep 17 00:00:00 2001 From: Zev Averbach Date: Mon, 21 Jul 2025 08:41:12 +0200 Subject: [PATCH] added CLAUDE.md --- CLAUDE.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 CLAUDE.md diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..921e06a --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,30 @@ +## Code Reference Priority + +**Always start with foundation docs** - Begin each session by reading `structure_preview.md` and `codebase_overview.md` for essential context. Then use module-specific summaries on-demand for areas you're working with. If they aren't present, skip this step and all the steps in the sections below. + +### Reference Hierarchy +1. **structure_preview.md** + **codebase_overview.md** - **Always read these first** for file organization and architecture +2. **Specific summaries** - Read only the summaries for modules/files you're working with +3. **Source files** - Read when summaries lack specific details or when you need to make changes + +### Documentation Usage Rules +1. **Start with foundation** - Always begin by reading structure_preview.md and codebase_overview.md +2. **Identify scope** - Determine which parts of the codebase are relevant to your task +3. **Search relevant summaries** - Use `Grep` or `Glob` to find summaries in `/summaries/` for only those areas +4. **Read selectively** - Only read summaries for modules you're actually working with +5. **Use source as needed** - Don't hesitate to read source files when documentation isn't sufficient + +### Available Documentation Types +- `structure_preview.md` - Directory tree, file organization, config files (**read first**) +- `codebase_overview.md` - High-level architecture, module relationships, data flow (**read first**) +- `/summaries/` directory - Module-specific API documentation and implementation details +- Individual `*_summary.md` files - Detailed summaries for specific components + +### Example Usage +``` +# Start of any session: +"Let me first read structure_preview.md and codebase_overview.md to understand the project..." + +# Then for specific tasks: +"Now I need to work with [module], so I'll search /summaries/ for relevant documentation..." +```