An app with no description says its README (#12409)
In /explore, GET /api/v1/explore, the MCP tool explore and the terminal's explorer lines (the dashboard's / search with kind: or sort:, src/tui/screens/dashboard.ts, which draws row.description as each row's second line), an app row whose description is empty shows the first sentence of its README instead.
- What it reads:
README.mdat the root of the app's default branch, and nothing else (noreadme.md,README, or other names). At most 16 KB of it. - What it takes: the first prose paragraph, skipping front matter, headings (ATX
#and setext titles underlined with===or---), fenced code, tables, badges, rules and html lines. Links and images keep their text;x,_x_,~~x~~and `xlose their markers, but only at word boundaries, somy_app_namestays as written. The sentence ends at.,!or?followed by space and a word that is not lowercase; a period aftere.g.,i.e.,vs.,cf.and similar, or inside a word likev1.0`, does not end it. - How long: at most 140 characters (
READMEDESC_MAX); a longer sentence is cut and ends with…. - Who sees it: public repositories only. A private app's README is never read for a row, and an app that goes private stops showing it on the next request; visibility comes from the ranked row.
- Cost: only the rows a page returns (after the cursor and limit) are filled, by
describedinsrc/core/readme_description.ts. The sentence is kept in memory by repository and branch tip, so a warm request costs one ref-file read per undescribed app and no git process; a push changes the tip and the sentence is read again. Sixty undescribed apps answer a warm/explorein about 10–16 ms (test/explore-description-speed.test.tsprints the number).
The page escapes the sentence like any description; nothing in it is markup.