Skip to content

Commit bf2fc14

Browse files
committed
feat(docs): add Pilot architecture documentation and diagram
- Add comprehensive documentation section for Pilot component explaining its role as the intelligence layer in the retrieval system - Document intervention points (START, FORK, BACKTRACK, EVALUATE) where Pilot acts - Include score merging formula combining algorithm and LLM scores - Add fallback strategy explanation with 4-level degradation approach - Create detailed SVG architecture diagram showing Pilot's relationship to retrieval pipeline - Illustrate intervention points with visual flow and design philosophy
1 parent 9a52b96 commit bf2fc14

2 files changed

Lines changed: 222 additions & 0 deletions

File tree

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,25 @@ Uses adaptive, multi-stage retrieval with backtracking:
5858

5959
This mimics how humans navigate documentation: skim the TOC, drill into relevant sections, and backtrack when needed.
6060

61+
### Pilot: The Brain
62+
63+
**Pilot** is the intelligence layer that guides retrieval:
64+
65+
- **Intervention Points** — Pilot acts at key decision moments:
66+
- **START** — Analyze query intent, set initial direction
67+
- **FORK** — Rank candidates at branch points
68+
- **BACKTRACK** — Suggest alternatives when search fails
69+
- **EVALUATE** — Assess content sufficiency
70+
71+
- **Score Merging** — Combines algorithm scores with LLM reasoning:
72+
```
73+
final_score = α × algorithm_score + β × llm_score
74+
```
75+
76+
- **Fallback Strategy** — 4-level degradation (Normal → Retry → Simplified → Algorithm-only)
77+
78+
- **Budget Control** — Token and call limits with intelligent allocation
79+
6180
## Comparison
6281

6382
| Aspect | Vectorless | Traditional RAG |
@@ -116,6 +135,12 @@ See the [examples/](examples/) directory for complete working examples:
116135

117136
## Architecture
118137

138+
### Pilot Architecture
139+
140+
![Pilot Architecture](docs/design/pilot-architecture.svg)
141+
142+
### System Overview
143+
119144
![Architecture](docs/design/architecture-v2.svg)
120145

121146
## Contributing

docs/design/pilot-architecture.svg

Lines changed: 197 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)