Skip to content

docs(build): say that search finds a file by its extracted text - #667

Merged
aicayzer merged 1 commit into
mainfrom
docs/search-file-text
Oct 26, 2026
Merged

aicayzer merged 1 commit into
mainfrom
docs/search-file-text

Conversation

@aicayzer

@aicayzer aicayzer commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Search finds a file by the text Marfa extracts from it. The docs did not say so. This adds that to the search guide, the files guide and the Items catalog page. The matching contract statements are in the marfa pull request linked below.

Changes

  • build/handle-files: a new "Find a file by its text" section: when the text is available, what a device needs, and the settings that switch it off.
  • build/list-filter-search: the Search section says a file's extracted_text is searched, and when.
  • catalog/items: "Searched fields" names extracted_text and says a file type cannot set searchable to false on it.

Testing

pnpm test passes (709 tests), including the content lint and the command check for marfa search --type core.file. The page was not built or viewed in a browser.

Notes for reviewers

  • Contract statements: test(conformance): search finds a file by its extracted text marfa#2412 (search-and-filters/search-file-text, device/index-file-text). The Items page does not link the statement yet, because the link check reads the synced contract; the sync pull request after the marfa one merges can add it.
  • The generated Catalog File page is unchanged: its field description does not contradict this.

Checklist

  • The title is a scoped Conventional Commit.
  • Pages follow STYLE.md.
  • Pages still say what is true after this change.

@aicayzer
aicayzer marked this pull request as ready for review October 26, 2026 15:57
@aicayzer
aicayzer merged commit 82b0b75 into main Oct 26, 2026
3 checks passed
@aicayzer
aicayzer deleted the docs/search-file-text branch October 26, 2026 16:54
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