Skip to content

docs: improve search_docs ranking for module-system and config queries#129

Merged
markshust merged 1 commit into
developfrom
feature/docs-markdown-search-ranking
Jun 23, 2026
Merged

docs: improve search_docs ranking for module-system and config queries#129
markshust merged 1 commit into
developfrom
feature/docs-markdown-search-ranking

Conversation

@markshust

Copy link
Copy Markdown
Collaborator

Summary

The final two misses from the live search_docs audit (run end-to-end in a real project) were BM25 ranking gaps, not missing content. Two small docs-markdown edits take the audit from 6/8 → 8/8:

  • concepts/modularity.md — lead on the literal phrase "module system" so the query stem matches the title's neighborhood (porter stems modulemodul, which never matched the title Modularitymodular). Q1: rank 5 → 1.
  • getting-started/configuration.md — add a "Where Config Defaults Go" heading + lead covering the query terms config/defaults/go (porter splits config from the doc's configuration). Q6: miss → rank 1.

Verification

End-to-end via claude -p against the live MCP, and independently re-checked against the real corpus in this repo:

Stage F
pre-fix 3/8
+ driver fix (#127) 6/8
+ these content tweaks 8/8 (seven at rank 1)

Closes out the audit

docs-markdown suite green: 17 passed.

🤖 Generated with Claude Code

Two BM25-ranking fixes (content present, just under-ranked) that take the live
search_docs audit from 6/8 to 8/8 (after the docs-fts driver fix in #127):

- concepts/modularity.md: lead on the literal phrase "module system" so the
  query stem matches the title's neighborhood (Q1: rank 5 -> 1).
- getting-started/configuration.md: add a "Where Config Defaults Go" heading +
  lead covering the query terms config/defaults/go, which porter stemming
  otherwise split from "configuration" (Q6: miss -> rank 1).

Verified end-to-end via `claude -p` against the live MCP: F = 8/8, seven at
rank 1. Closes the YELLOW item on the search_docs coverage audit (task 000);
docs-fts confirmed as the skeleton/devai default. docs-vec remains tracked in #128.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@markshust markshust merged commit 2d3d2b0 into develop Jun 23, 2026
1 check passed
@markshust markshust deleted the feature/docs-markdown-search-ranking branch June 23, 2026 22:38
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jun 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant