Generate the config reference documentation from the config registry - #2146

Merged

andygrove merged 23 commits into

apache:mainfrom

andygrove:config-docs-generator

Jul 22, 2026

Commits on Jul 22, 2026

feat(core): expose ConfigEntry metadata for doc generation
andygrove
committed
0883ab3
feat(core): render config registry as prettier-compatible tables
andygrove
committed
c1079ed
refactor: use expect instead of allow for dead_code lint
andygrove
committed
f6d67c9
feat(core): splice generated config tables into marked doc regions
andygrove
committed
c568ca3
Remove dead_code expectation from update_config_docs
andygrove
committed
dfa86a0
fix: scope dead_code expectation to non-test builds
andygrove
committed
8d1cb87
fix(config-docs): don't treat markers shown as examples as live
andygrove
committed
cebd5ae
feat(core): add update_config_docs CLI with drift and coverage checks
andygrove
committed
1861322
docs: generate config reference tables from the config registry
andygrove
committed
e9c8b0d
docs: clean up two config entry descriptions
andygrove
committed
5d34972
docs: drop redundant join reference in propagate-empty description
andygrove
committed
4bf041a
ci: check generated config docs stay in sync with the registry
andygrove
committed
4d28b77
docs: warn readers not to hand-edit generated config tables
andygrove
committed
f9db9dc
docs: use plain prose for the generated-tables notice
andygrove
committed
9639699
ci: install protoc before config-docs-check job
andygrove
committed
340e42e
build: run update_config_docs with the ci profile
andygrove
committed
4e41417
fix: report written files even when the orphan-key check fails
andygrove
committed
2b4baa9
fix: reject unrecognised arguments instead of defaulting to write mode
andygrove
committed
1c57af7
fix: collapse newlines in escape_cell
andygrove
committed
e97bbfb
fix: point orphan-key error at the right section, not prefix widening
andygrove
committed
6939702
docs: document the config docs generator in CONTRIBUTING
andygrove
committed
5c41324
Merge remote-tracking branch 'apache/main' into config-docs-generator
andygrove
committed
15ca0b2
docs: regenerate config tables after merging main
andygrove
committed
7dc1127

Navigation Menu

Uh oh!

Generate the config reference documentation from the config registry - #2146

Generate the config reference documentation from the config registry#2146
andygrove merged 23 commits into
apache:mainfrom
andygrove:config-docs-generator

Commits on Jul 22, 2026

feat(core): expose ConfigEntry metadata for doc generation

feat(core): render config registry as prettier-compatible tables

refactor: use expect instead of allow for dead_code lint

feat(core): splice generated config tables into marked doc regions

Remove dead_code expectation from update_config_docs

fix: scope dead_code expectation to non-test builds

fix(config-docs): don't treat markers shown as examples as live

feat(core): add update_config_docs CLI with drift and coverage checks

docs: generate config reference tables from the config registry

docs: clean up two config entry descriptions

docs: drop redundant join reference in propagate-empty description

ci: check generated config docs stay in sync with the registry

docs: warn readers not to hand-edit generated config tables

docs: use plain prose for the generated-tables notice

ci: install protoc before config-docs-check job

build: run update_config_docs with the ci profile

fix: report written files even when the orphan-key check fails

fix: reject unrecognised arguments instead of defaulting to write mode

fix: collapse newlines in escape_cell

fix: point orphan-key error at the right section, not prefix widening

docs: document the config docs generator in CONTRIBUTING

Merge remote-tracking branch 'apache/main' into config-docs-generator

docs: regenerate config tables after merging main