You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
docs: align README with implementation and trim repetition - #164
Reduce README wording by roughly 33%, removing repeated benchmark narratives and marketing language while retaining the flag reference and operational caveats.
Correct server-only options, save timing, locking claims, posting format, encoding behavior, and index freshness guidance against the implementation.
Fix search examples, build instructions, and architecture-specific installation commands.
Validation
Cross-checked documentation against CLI parsing, search/index/server code, release workflows, and benchmark documentation.
Checked local links and heading anchors, documented CLI flags, code-fence balance, and git diff --check.
Documentation-only change; no application tests run.
This documentation-only PR condenses the README and aligns usage, indexing, server, search, and installation guidance with the implementation.
Changes:
Reduces repeated performance and architecture content.
Updates CLI, watcher, freshness, encoding, and index guidance.
Corrects build and installation examples.
Review findings:
Critical (README.md:531): Several flags do not automatically bypass indexed searches as documented and may be ignored without --no-index; update the bypass behavior and add tests.
Moderate (README.md:41): Scope parallel matching claims to server RPC searches.
Moderate (README.md:46): Describe 0.93x as a measured ratio, not a speedup.
Moderate (README.md:163): Document that --max-memory also applies to fresh index builds.
Moderate (README.md:164): Clarify that --index-threads does not control fresh bootstrap builds.
Moderate (README.md:184): Describe watcher fallback in terms of incomplete native coverage.
Moderate (README.md:512): Scope binary-file exceptions to searches, not indexing.
File
Description
README.md
Consolidates and corrects project documentation and examples.
This still overstates parallelism for non-server searches. Only server RPC matching uses Rayon (serve.rs:1932-1939); local-index and filesystem paths iterate candidates sequentially (search.rs:1331-1352, 1518-1539). Remove the general parallel claim or scope it explicitly to server-backed queries.
Document sticky polling fallback for incomplete coverage
README.md:190
The watcher also switches to sticky polling when the coverage walk is incomplete, not only for a budget or native-registration failure: apply_watch_registrations_locked reports this case at tgrep-cli/src/serve.rs:3615-3623. Please retain that operational fallback caveat in the shortened description.
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
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.
Summary
Validation
git diff --check.