Skip to content

Latest commit

 

History

History
53 lines (40 loc) · 1.83 KB

CLAUDE.md

File metadata and controls

53 lines (40 loc) · 1.83 KB

Agentmap Integration

This project uses agentlens for AI-optimized documentation.

Reading Protocol

Follow this order to understand the codebase efficiently:

  1. Start here: .agentlens/INDEX.md - Project overview and module routing
  2. AI instructions: .agentlens/AGENT.md - How to use the documentation
  3. Module details: .agentlens/modules/{module}/MODULE.md - File lists and entry points
  4. Before editing: Check .agentlens/modules/{module}/memory.md for warnings/TODOs

Documentation Structure

.agentlens/
├── INDEX.md              # Start here - global routing table
├── AGENT.md              # AI agent instructions
├── modules/
│   └── {module-slug}/
│       ├── MODULE.md     # Module summary
│       ├── outline.md    # Symbol maps for large files
│       ├── memory.md     # Warnings, TODOs, business rules
│       └── imports.md    # Dependencies
└── files/                # Deep docs for complex files

During Development

  • Use .agentlens/modules/{module}/outline.md to find symbols in large files
  • Check .agentlens/modules/{module}/imports.md for dependencies
  • For complex files, see .agentlens/files/{file-slug}.md

Commands

Task Command
Regenerate docs agentlens
Fast update (changed only) agentlens --diff main
Check if stale agentlens --check
Force full regen agentlens --force

Key Patterns

  • Module boundaries: mod.rs (Rust), index.ts (TS), __init__.py (Python)
  • Large files: >500 lines, have symbol outlines
  • Complex files: >30 symbols, have L2 deep docs
  • Hub files: Imported by 3+ files, marked with 🔗
  • Memory markers: TODO, FIXME, WARNING, SAFETY, RULE

Generated by agentlens