docgen

command
v1.38.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 4, 2026 License: GPL-3.0 Imports: 17 Imported by: 0

Documentation

Overview

Command docgen regenerates the code-derived reference pages under docs/reference/ from the actual source: HTTP routes, MCP tool schemas, config structs, and the broker-ctl CLI. CI runs `go run ./tools/docgen` and fails if the result differs from what is committed (`git diff --exit-code docs/reference`), so the reference cannot drift from the code.

Usage: go run ./tools/docgen (writes docs/reference/*.md)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL