apidoc

Documentation

Overview

Command apidoc extracts this module's public API into a JSON document, so a documentation site can render real signatures instead of hand-maintaining a table that drifts.

go run ./cmd/apidoc -out api.json

Output is deterministic — everything sorted, no timestamps, no paths from the generating machine — so a regenerate-and-diff check can guarantee the published reference matches the code.

It walks the module rather than consulting a list of packages to document. The list was the previous design and it went stale in exactly the way you would expect: packages were deleted and the reference kept describing them.