Document generation tool

[knutwannheden]

There should be some form of documentation generation tool for a platform. While the documentation for the platform extensions will typically be mostly written by hand, there is probably also aspects which could be generated from the platform.

Quarkus' annotation processor already generates Asciidoc tables documenting all configuration properties (which have been defined in Java code using @ConfigRoot et al.) for each individual extension. In addition there is a tool which generates an overview of all configuration options in the entire platform (see https://github.com/quarkusio/quarkus/blob/main/docs/src/main/java/io/quarkus/docs/generation/AllConfigGenerator.java) by concatenating (and sorting) JSON files generated by the annotation processor. Having something similar in the platform tooling would probably also make sense.

Similarly there is also a Jbang script in Quarkus which generates an overview of all build steps: https://github.com/quarkusio/quarkus/blob/main/.github/quarkusbuilditemdoc.java.

This idea requires some more thought and elaboration.

[knutwannheden]

The document generation tool could also generate a page documenting the platform properties provided by the platform.