Skip to content

Commit 5b4dbe4

Browse files
committed
docs: document index versioning (phase 06) and relationship sidecar (phase 07)
1 parent 3a1406c commit 5b4dbe4

File tree

3 files changed

+9
-0
lines changed

3 files changed

+9
-0
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
### Added
66

7+
- **Index versioning (Phase 06)**: Index artifacts are versioned via `index-meta.json`. Mixed-version indexes are never served; version mismatches or corruption trigger automatic rebuild.
8+
- **Crash-safe rebuilds (Phase 06)**: Full rebuilds write to `.staging/` and swap atomically only on success. Failed rebuilds don't corrupt the active index.
9+
- **Relationship sidecar (Phase 07)**: New `relationships.json` artifact containing file import graph, reverse imports, and symbol export index. Updated incrementally alongside the main index.
710
- Tree-sitter-backed symbol extraction is now used by the Generic analyzer when available (with safe fallbacks).
811
- Expanded language/extension detection to improve indexing coverage (e.g. `.pyi`, `.php`, `.kt`/`.kts`, `.cc`/`.cxx`, `.cs`, `.swift`, `.scala`, `.toml`, `.xml`).
912
- New tool: `get_symbol_references` for concrete symbol usage evidence (usageCount + top snippets).

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,7 @@ The retrieval pipeline is designed around one goal: give the agent the right con
207207
- **Import centrality** - files that are imported more often rank higher.
208208
- **Cross-encoder reranking** - a stage-2 reranker triggers only when top scores are ambiguous. CPU-only, bounded to top-K.
209209
- **Incremental indexing** - only re-indexes files that changed since last run (SHA-256 manifest diffing).
210+
- **Version gating** - index artifacts are versioned; mismatches trigger automatic rebuild so mixed-version data is never served.
210211
- **Auto-heal** - if the index corrupts, search triggers a full re-index automatically.
211212

212213
## Language Support
@@ -239,7 +240,9 @@ Structured filters available: `framework`, `language`, `componentType`, `layer`
239240
```
240241
.codebase-context/
241242
memory.json # Team knowledge (should be persisted in git)
243+
index-meta.json # Index metadata and version (generated)
242244
intelligence.json # Pattern analysis (generated)
245+
relationships.json # File/symbol relationships (generated)
243246
index.json # Keyword index (generated)
244247
index/ # Vector database (generated)
245248
```

docs/capabilities.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,10 @@ Output: `{ ready: boolean, reason?: string }`
8484

8585
- Initial: full scan → chunking (50 lines, 0 overlap) → embedding → vector DB (LanceDB) + keyword index (Fuse.js)
8686
- Incremental: SHA-256 manifest diffing, selective embed/delete, full intelligence regeneration
87+
- Version gating: `index-meta.json` tracks format version; mismatches trigger automatic rebuild
88+
- Crash-safe rebuilds: full rebuilds write to `.staging/` and swap atomically only on success
8789
- Auto-heal: corrupted index triggers automatic full re-index on next search
90+
- Relationships sidecar: `relationships.json` contains file import graph and symbol export index
8891
- Storage: `.codebase-context/` directory (memory.json + generated files)
8992

9093
## Analyzers

0 commit comments

Comments
 (0)