Keyring
Reference

Reference

Every public package and every control-plane endpoint, generated from the code rather than written about it.

Both halves of this reference are produced by packages/docs/tools/generate-reference.mjs, and a test in the docs package regenerates them and fails if the committed pages differ from what the current source produces. Nothing here is hand-copied.

How it is generated

Packages. The generator builds a TypeScript program from each package's own tsconfig.lib.json, walks the exports of its entry module with the type checker, and prints each one: functions without bodies, classes with their public members, interfaces and type aliases verbatim, constants with their checked type. The prose under each is the source's own doc comment, so it is the same text a hover in your editor shows.

Endpoints. The generator parses every *.controller.ts in the control plane, reads its @Controller prefix, route decorators, @HttpCode, @Param, @Body and @Query, and inlines the zod schema each body or query is validated by, with the validators shared across pages collected once per page. The guard on each controller becomes the "Authentication" line. Response shapes come from the serializer the controllers share. A controller with no page fails the generator.

On this page