Repository navigation
docs: rewrite README around architecture and measured engineering results - #56
Merged
Merged
Conversation
…ults Lead with what lgrep is, an at-a-glance summary, and a Mermaid architecture diagram. Add an engineering-highlights section whose every number comes from the merged pull request that measured it. Fold the tool, CLI, and environment reference into collapsible sections with their content unchanged.
Correct the quick-start semantic sequence (index before search), the cancellation and GIL descriptions, the symbol-index migration behaviour, and the re-rank agreement figure; record the memory cost #45 accepted.
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.
Problem
The README read as a reference manual: tool tables, CLI flags, and 20 environment variables. It did not state what the project's engineering work achieved, though the merged PRs record those measurements. A reader evaluating the repository saw configuration first and no evidence of the systems work behind it.
Change
README.mdonly:<details>blocks. Their content is unchanged.Verification
src/lgrep/server/tools_*.py, that every environment variable is read insrc, that every CLI command exists insrc/lgrep/cli.py, that every linked path and anchor exists, and that all 12 linked PRs are merged.index-symbolsandsearch-symbolsran from a fresh virtualenv. The semantic sequence was not run end to end because it needs a Voyage key.