Documentation
¶
Overview ¶
Command docsgen generates the reference-data JSON that the docs site renders, so those tables can never drift from the implementation.
It derives, straight from the Go source of truth:
- docs-site/src/data/generated/config.json — every GATEWAY_* environment variable, extracted from internal/config/config.go (name, inferred type, default value, required flag, description, grouping category).
- docs-site/src/data/generated/audit-events.json — every audit event-type string, extracted from the EventType constants in pkg/audit/logger.go.
Run it via `make docs-gen` or `go generate ./...`. The emitted files are generated artifacts: do not hand-edit them.
Click to show internal directories.
Click to hide internal directories.