talos/hack/docgen
Andrey Smirnov 16c5fa64f6 docs: improve configuration reference documentation
`docgen` now correctly extracts documentation for the structure itself,
and supports mix of Go-style and yaml-style docblocks, so that we can
keep linter happy while embedding examples.

Fixes for the encoder to keep things marshaled same way even with the
presence of the struct docs.

Add real examples replacing fake ones.

Add top-level hacked examples for `Config`, `MachineConfig` and
`ClusterConfig` to show the overall structure without pulling in all the
deep structure of those types.

Fixes #2768

Signed-off-by: Andrey Smirnov <smirnov.andrey@gmail.com>
2020-11-13 11:50:26 -08:00
..
go.mod feat: encode comments as part of talosctl generated configs 2020-10-26 13:05:23 -07:00
go.sum feat: encode comments as part of talosctl generated configs 2020-10-26 13:05:23 -07:00
main.go docs: improve configuration reference documentation 2020-11-13 11:50:26 -08:00