Documentation
¶
Overview ¶
Command brigade-docs is the documentation gate's front end (card 110):
brigade-docs check run every rule of internal/docscheck against the tree; exit 1 on a finding
brigade-docs generate rewrite the generated reference pages: docs/developer/reference/make-targets.md
from the Makefile's help lines and docs/developer/reference/commands.md from
internal/cli's command table (card 112)
`make docs-check` and `make docs-generate` run it with `go run` from the repository root. The same rules run in `make test` through scripts/ci/docs_check_test.go, which is what CI, `make push` and the release sequence execute; this command exists so a person can read the findings without a test harness around them.
The command is DEV-ONLY and never shipped; `make build` does not build it.
Click to show internal directories.
Click to hide internal directories.