Reference

Reference

Exhaustive lookup material — configuration keys, CLI, error codes, the API/transport surface, and terminology.

Reference pages are for lookup, not learning. When you already know the concept and just need the exact key, flag, code, endpoint, or term, this is where to find it.

The public vocabulary — Work, Route, Settlement — is a reading layer over stable API and domain names; the glossary carries the bridge from each primitive to the type it maps onto (Work is a Routable, and so on). Reference pages use the technical names, because that is what you type.

What lives here:

  • Configuration — every DUCTOR_* variable and YAML key, per subsystem.
  • CLI — every ductor subcommand, flag, and exit code.
  • Errors & status codes — the stable error catalog and its wire mapping.
  • API surface — how methods are served (ConnectRPC / gRPC / REST), the interceptor chain, versioning, rate limits, pagination, and health endpoints.
  • Glossary — the vocabulary used across the docs and product.