guides.scan

Where a string appears in the documentation, and the lines around it.

Use it when you know the exact spelling of something — an API name, a field, a setting — and want every place it is written. guides.search answers the other question: which guide ANSWERS what you are asking, ranked by meaning, which finds a guide whose wording differs from your own. Neither replaces the other, and reaching for the wrong one is the difference between "no guide mentions PlayerPrototype" and "no guide explains how players work".

Ranking

A guide carrying more distinct terms of the query outranks one carrying fewer, then one carrying them more often, then by path so two equal hits keep their order between calls. path narrows the scan to the guides under a prefix; omitted, it scans every guide and asset type the catalogue holds.

Snippets

Each hit carries the matching lines with their line numbers and contextLines of surrounding text. A line is carried once however many terms land on it or how many neighbours reach it, so overlapping matches read as one passage rather than repeating.