Documentation
¶
Overview ¶
Command mwdocsgen writes the middleware reference pages for the documentation site from the middleware catalog.
The catalog already carries every field's label, type, default, options and help text — it is what the API returns and what the console's form renders from. Hand-writing twenty pages of the same information guarantees the two disagree within a release, and the docs are the copy nobody notices going stale. So the reference is generated, and a test asserts the committed pages match the catalog.
Prose that is not derivable — what a middleware is for, when to reach for it — lives in the hand-written overview page, which this does not touch.
go run ./cmd/mwdocsgen -o ../docs/docs/middlewares
Click to show internal directories.
Click to hide internal directories.