DocShell.Presentation.SearchAdapter behaviour (DocShell v0.5.0)

Copy Markdown View Source

Build-time adapter for a validated, renderer-neutral search corpus.

Adapters return local assets and an inert browser query contract. They do not receive a destination path, make network requests, or introduce a served runtime dependency.

Summary

Callbacks

build(list, keyword)

Builds local search assets and a browser-neutral query contract.

Callbacks

build(list, keyword)

@callback build([DocShell.Presentation.SiteSearchEntry.t()], keyword()) ::
  {:ok, DocShell.Presentation.SearchAdapter.Output.t()} | {:error, term()}

Builds local search assets and a browser-neutral query contract.