Skip to content

docs: rewrite README around architecture and measured engineering results - #56

Merged
JRedeker merged 2 commits into
mainfrom
work/work-d9ccc34a190b0f2599da5045
Oct 25, 2026
Merged

JRedeker merged 2 commits into
mainfrom
work/work-d9ccc34a190b0f2599da5045

Conversation

@JRedeker

Copy link
Copy Markdown
Contributor

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.md only:

Verification

  • A script checked that all 22 tool names are registered in src/lgrep/server/tools_*.py, that every environment variable is read in src, that every CLI command exists in src/lgrep/cli.py, that every linked path and anchor exists, and that all 12 linked PRs are merged.
  • An independent review checked each figure against its PR body and the architecture text against the source. It fixed four MEDIUM wording overstatements in the second commit. The Mermaid diagram renders with mermaid-cli 12.
  • The reference tables match the previous README line for line.
  • index-symbols and search-symbols ran from a fresh virtualenv. The semantic sequence was not run end to end because it needs a Voyage key.

…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.
@JRedeker
JRedeker enabled auto-merge (squash) October 25, 2026 14:20
@JRedeker
JRedeker merged commit 7af7f38 into main Oct 25, 2026
4 checks passed
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