Skip to content

docs: update grep descriptions for passthrough behavior#871

Open
BadassBison wants to merge 1 commit intortk-ai:developfrom
BadassBison:docs/grep-passthrough-and-truncation-fixes
Open

docs: update grep descriptions for passthrough behavior#871
BadassBison wants to merge 1 commit intortk-ai:developfrom
BadassBison:docs/grep-passthrough-and-truncation-fixes

Conversation

@BadassBison
Copy link
Copy Markdown
Contributor

Summary

Doc-only follow-up to #791 (grep false negatives, output mangling, and truncation annotations).

Updates all relevant documentation to reflect the behavioral changes made in that PR:

  • rtk grep now passes through raw file:line:content output for <=50 matches, and uses the grouped format only for >50 matches
  • --no-ignore-vcs is used (not --no-ignore) so .ignore/.rgignore are still respected
  • Savings range updated to 0-90% to reflect passthrough for small result sets

Files changed

File Change
README.md grep description: "Grouped search results" → "Search results (raw <=50, grouped >50)"
README_es.md / fr / ja / ko / zh Same update in each language
ARCHITECTURE.md SYSTEM savings range: 50-90%0-90%
INSTALL.md grep description updated
docs/AUDIT_GUIDE.md grep savings note updated
docs/FEATURES.md Full grep objective updated, --no-ignore--no-ignore-vcs

…ehavior

- grep: always filters output in file:line:content format (--no-ignore-vcs, truncated lines, capped)
- smart_truncate: documents smart selection logic with [N more lines] end marker (no inline // ... annotations)
- ARCHITECTURE.md: SYSTEM savings range restored to 50-90%
- AUDIT_GUIDE.md: grep savings updated to 50-90%
- All language READMEs updated to reflect filtered (not passthrough) output
@BadassBison BadassBison force-pushed the docs/grep-passthrough-and-truncation-fixes branch from b725ef7 to f398e1f Compare April 14, 2026 13:55
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.

2 participants