Skip to content

Bring the README up to date with the app, add a screenshot, and bump Pillow - #219

Merged
ben-dev-au merged 2 commits into
mainfrom
docs/readme-audit
Oct 21, 2026
Merged

ben-dev-au merged 2 commits into
mainfrom
docs/readme-audit

Conversation

@ben-dev-au

@ben-dev-au ben-dev-au commented Oct 21, 2026 •

Copy link
Copy Markdown
Owner

Problem

The README had drifted from the app, and much of it was long-form prose.

  • Space (Quick Look) was removed in Native text selection & copy by default (+ Reading View, opt-in mouse) #16 but still documented.
  • Missing keys: n/b (match navigation), z (Reading View), r/p/c/f pane focus, X clear filters, Ctrl+Y copy query as command, Ctrl+Enter batch toggle, custom keybindings.
  • Settings paths named menus that no longer exist (Indexing, Cache size, Cache maintenance, Reindex). The app says Indexing & PDF Texture, PDF Texture Cache, Update index.
  • After installing the texturising engine it said to reindex, which skips unchanged PDFs; Texturise flat PDFs is the step.
  • Wrong facts: "60 file types" (40), --kind / kind: listed five types and no categories, result_limit = 200 (default 50), pipx "brings Python", "repeat --source" (the CLI takes one per command), "no network" (semantic search downloads its model), and an intent: DSL credited in the acknowledgements does not exist.
  • : was described as opening Settings from anywhere; in the query bar it types a colon.

Changes

  • Description: leads with 100% local and private, BM25 ranking, in-file navigation, Open with…, lazygit-style TUI; Markdown first.
  • Screenshot at assets/fnd_screenshot_sml.jpg, by absolute URL so it renders on PyPI too (the README is the fndr long description). It shows once this is on main.
  • Quick start is a getting-started guide: first collection from the TUI (a fresh install opens into Add collection), from the CLI, everyday use, and Obsidian (App: Obsidian, vault name, Advanced URI).
  • Command table leads with fnd <query> -c <collection>, the usual way in.
  • Platform status stated once instead of four times; outdated "Upgrading an existing index" note removed; long prose turned into bullets. App terminology kept throughout so README sections match what the TUI shows.
  • Tests: three tests matched README table rows by exact spacing, which a markdown formatter's column padding broke; they now match by pattern.

Also: Pillow 13.0.0

  • pip-audit flags CVE-2026-112895 and seven others in Pillow 12.3.0, all fixed in 13.0.0; this failed the security check here and will fail main's scheduled run.
  • Pillow arrives only via python-pptx (Pillow>=3.3.2); fnd never imports PIL. Lock-only change.
  • Audit: the new lock reports no known vulnerabilities; the old lock reports the CVEs.

Verification

  • Every key, menu path, CLI flag and config key checked against the code; menu paths and fnd binary tree -c notes driven in the real TUI in tmux on a fresh HOME.
  • Negative control: the old literal | Filter | What it does | no longer occurs in the formatted README.
  • make batch-close with Pillow 13.0.0: 6353 passed, ruff and pyright clean, 12 harness scenarios passed (1 skipped, needs real corpus).

Depends on

  • Quick start step 1 assumes a fresh install opens into Add collection. Today fnd exits with "No collections yet"; that fix is in progress separately.

The README had drifted from the app:
- Space (Quick Look) was removed in #16 but still documented.
- n/b, z (Reading View), r/p/c/f, X, Ctrl+Y, Ctrl+Enter and custom
  keybindings were missing.
- Settings paths named menus that no longer exist (Indexing, Cache size,
  Cache maintenance, Reindex); the app now says Indexing & PDF Texture,
  PDF Texture Cache and Update index.
- After installing the texturising engine it said to reindex, which skips
  unchanged PDFs; Texturise flat PDFs is the step.
- "60 file types" (there are 40), --kind and kind: listed five types and
  no categories, result_limit showed 200 (default 50), pipx was said to
  bring Python, "repeat --source" (the CLI takes one per command), "no
  network" (semantic search downloads its model), and an intent: DSL
  credited in the acknowledgements does not exist.

Also:
- Quick start is now a getting-started guide (TUI first, then CLI), with
  an Obsidian section; `fnd <query> -c <collection>` leads the command
  table as the usual way in.
- Markdown leads every list of file types; the description leads with
  local and private, BM25 ranking and the TUI.
- Platform status was stated four times; now once.
- The screenshot uses an absolute URL so it renders on PyPI too.
- Three tests matched README table rows by exact spacing, which a
  markdown formatter's column padding broke; they now match by pattern.
@coderabbitai

coderabbitai Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: b6ead99d-93f5-41cd-85b3-de70f1f75b56
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

pip-audit flags CVE-2026-112895 and seven others in Pillow 12.3.0, all
fixed in 13.0.0. Pillow arrives only through python-pptx, which accepts
any Pillow>=3.3.2; fnd itself never imports PIL. Lock-only change.
@ben-dev-au ben-dev-au changed the title Bring the README up to date with the app, and add a screenshot Bring the README up to date with the app, add a screenshot, and bump Pillow Oct 21, 2026
@ben-dev-au
ben-dev-au merged commit 9f9bce2 into main Oct 21, 2026
22 checks passed
@ben-dev-au
ben-dev-au deleted the docs/readme-audit branch October 21, 2026 06:01
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