Skip to content

SearchDocType

reference
1 min readUpdated

Kind: Type

Source: atloria-monorepo/apps/api/src/technical-docs/search-index.ts

Prebuilt STATIC search index for a published site (F4).

A compact, self-contained JSON blob the reader fetches once and searches client-side when the live search API (Azure AI Search / Postgres) is unavailable — so search survives an API outage or a static export.

This module is a PURE transform (no I/O) so it is fully unit-testable: the materializer fetches the corpus + entity graph and hands them here.

SUPERIOR: for technical-doc sites each page carries an entity-graph importance boost (call-graph in-degree centrality + public-API-surface weight). The client scorer uses it as a tie-breaker so the important ~5% of thousands of generated reference pages float to the top. User-manual pages (no code graph) get boost 0 and rank on text alone.

Definition

ts
'user_manual' | 'technical_ref'

Was this page helpful?

Download as PDF