33 lines
1.1 KiB
Markdown
33 lines
1.1 KiB
Markdown
# Machine-Readable Code Maps
|
|
|
|
Auto-generated JSON files for LLM development assistance.
|
|
|
|
**⚠️ Git-ignored** - Regenerate with: `python tools/generate_code_map.py`
|
|
|
|
## Files
|
|
|
|
- `code_map_api.json` - Function signatures, parameters, return types, docstrings
|
|
- `code_map_architecture.json` - Autoloads, design patterns, system structure
|
|
- `code_map_flows.json` - Signal chains, scene transitions, call graphs
|
|
- `code_map_security.json` - Input validation, error handling patterns
|
|
- `code_map_assets.json` - Asset dependencies, licensing information
|
|
- `code_map_metadata.json` - Code quality metrics, test coverage, TODOs
|
|
|
|
## Diagrams
|
|
|
|
**Location**: `diagrams/` subdirectory (also copied to `docs/generated/diagrams/` for standalone viewing)
|
|
|
|
**Contents**:
|
|
- `*.mmd` - Mermaid source files (architecture, signal flows, scene hierarchy, dependencies)
|
|
- `*.png` - Rendered PNG diagrams
|
|
|
|
**Note**: Diagrams are automatically copied to `docs/generated/diagrams/` when generating documentation.
|
|
|
|
## Format
|
|
|
|
All JSON files are **minified** (no whitespace) for optimal LLM token efficiency.
|
|
|
|
## Usage
|
|
|
|
See root `CLAUDE.md` for integration with LLM development workflows.
|