Skip to main content

Module docs_catalog

Module docs_catalog 

Source
Expand description

The one description of what this binary’s corpus holds.

Every document the binary carries is already one command away. What is missing is a route: a list of bare names tells a reader nothing about which name answers their question. This catalog carries the summary and the aliases an author owes that reader, and one resolver turns a question into exactly one topic.

Size is never authored. It is read from the embedded bytes when asked, so a number here can never disagree with the document it describes.

Structs§

Catalog
The whole catalog, parsed.
Topic
One thing a reader can ask for.

Enums§

CatalogError
A catalog this engine cannot read.
Kind
What a topic is, for grouping the index.
ShelfId
Which shelf serves a document topic.
Target
What reading a topic gets the reader.
Unresolved
Why a query resolved to no single topic.

Constants§

CATALOG_PATH
Where the catalog sits inside a bundle.
JSON_SCHEMA
The machine schema sdd docs --json declares.
SCHEMA
The schema this engine reads.

Statics§

CATALOG
What this binary’s own release declares its corpus to hold.