Repository navigation
docs: add docs/ARCHITECTURE.md explaining the retrieval pipeline - #56
Merged
Merged
Conversation
New contributors had to reverse-engineer how retrieval works from the
|
@wufangyong973 is attempting to deploy a commit to the vignesh's projects Team on Vercel. A member of the Team first needs to authorize it. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #38.
New contributors had to reverse-engineer how retrieval works from the code and
AGENTS.md. This adds a shortdocs/ARCHITECTURE.mdthat lowers that barrier, covering the scope called out in the issue:fts.ts,vector-index.ts+embeddings.ts,entities.ts,fusion.ts, assembled incontext.ts).migrate.ts.lib/, tools just wire it up.npm run bench, and the local-first no-LLM / no-network constraint.Every claim is grounded in the existing source and its module header comments (e.g. the query-side-IDF invariant in
idf.ts, the three-tier design and the stemmed-prefix +9.1 hit@5 gain infts.ts, the weighted-RRF and re-sweep rule infusion.ts).Wiring: link it from
README.md, and drop the now-stale "(if present)" hedge from thedocs/ARCHITECTURE.mdlink inCONTRIBUTING.md.