Reference
=========

Precise, factual descriptions of the surface a consuming project writes
against: the variables it sets, the registry it declares its documents in, the
directives and roles its authors use, and the command-line tools it runs.

This is **task-facing** reference — what you need to *use* zdocs. Signatures of
the engine's own Python modules and CMake commands are **implementation**
reference and live in the companion API document,
:external+zdocs-api:doc:`index`, generated from the sources themselves. Pages
here link into it rather than restating a signature that would then have two
places to drift from.

.. toctree::
   :maxdepth: 1

   consumer-contract
   registry-schema
   directives-and-roles
   cli
   glossary
   xref-smoke-test