Skip to content

Update docs with missing modules, hybrid search, and benchmark details#51

Merged
rendro merged 1 commit intomainfrom
docs/update-markdown-files
Feb 7, 2026
Merged

Update docs with missing modules, hybrid search, and benchmark details#51
rendro merged 1 commit intomainfrom
docs/update-markdown-files

Conversation

@rendro
Copy link
Owner

@rendro rendro commented Feb 7, 2026

Summary

  • CLAUDE.md: Add 4 missing modules to Core Components (document.rs, item.rs, error.rs, retry.rs), fix similarity boosting description to match actual code (0.875x cross-project penalty, not 1.15x/0.95x), document hybrid FTS/BM25 search, add SQLite indexes to schema
  • README.md: Add hybrid search as a key feature, fix project scoping description to reflect penalty-based (not boost-based) behavior
  • BENCHMARKS.md: Add nDCG@5 metric, per-category Recall@5 and MRR breakdowns, expanded temporal correctness table, and p50/p95/p99 latency tables sourced from latest sediment-bench run

Test plan

  • Verify all markdown renders correctly on GitHub
  • Cross-check benchmark numbers against sediment-bench/results/report.md
  • Confirm similarity boosting values match lib.rs::boost_similarity()

…ails

- CLAUDE.md: Add missing modules (document.rs, item.rs, error.rs, retry.rs),
  fix similarity boosting (0.875x penalty, not 1.15x/0.95x), add hybrid
  FTS/BM25 search, add SQLite indexes to schema
- README.md: Add hybrid search feature, fix project scoping description
- BENCHMARKS.md: Add nDCG@5, category breakdowns, temporal correctness
  details, and p50/p95/p99 latency tables from sediment-bench
@rendro rendro merged commit 423d4bd into main Feb 7, 2026
2 checks passed
@rendro rendro deleted the docs/update-markdown-files branch February 7, 2026 21:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant