forked from nguyenphutrong/quotio
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path.cursorrules
More file actions
53 lines (40 loc) · 1.83 KB
/
.cursorrules
File metadata and controls
53 lines (40 loc) · 1.83 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# 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](https://github.com/nguyenphutrong/agentlens)*