-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
docsDocumentation, guides, and examplesDocumentation, guides, and examples
Description
Summary
docs/architecture/PERFORMANCE.md contains fabricated benchmark data, non-existent APIs, and claims about unimplemented features.
Findings
| Issue ID | Description |
|---|---|
| PERF-001 | Contains fabricated benchmarking data with no backing tests |
| PERF-002 | Documents non-existent public APIs (SearchEngine::with_cache_config, etc.) |
| PERF-003 | Claims unimplemented features (LRU cache, memory mapping) |
Recommendation
Either:
- Delete the file entirely if performance documentation isn't needed
- Rewrite with actual benchmarks from
cargo benchresults
Files to Update
docs/architecture/PERFORMANCE.md- Delete or rewrite
Source of Truth
benches/directory for actual benchmark codecargo benchoutput for real numbers
Priority
Critical - Misleading users about performance characteristics.
Metadata
Metadata
Assignees
Labels
docsDocumentation, guides, and examplesDocumentation, guides, and examples