1.8 KiB
1.8 KiB
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
- structure_preview.md + codebase_overview.md - Always read these first for file organization and architecture
- Specific summaries - Read only the summaries for modules/files you're working with
- Source files - Read when summaries lack specific details or when you need to make changes
Documentation Usage Rules
- Start with foundation - Always begin by reading structure_preview.md and codebase_overview.md
- Identify scope - Determine which parts of the codebase are relevant to your task
- Search relevant summaries - Use
GreporGlobto find summaries in/summaries/for only those areas - Read selectively - Only read summaries for modules you're actually working with
- 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.mdfiles - 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..."