v.24.10Improvement

Embedded Documentation for Settings: Enhanced Completeness and Auto-Generation from Source Code

Official CH changelog text
Embedded documentation for settings will be strictly more detailed and complete than the documentation on the website. This is the first step before making the website documentation always auto-generated from the source code. This has long-standing implications: - it will be guaranteed to have every setting; - there is no chance of having default values obsolete; - we can generate this documentation for each ClickHouse version; - the documentation can be displayed by the server itself even without Internet access. Generate the docs on the website from the source code. #70289 (Alexey Milovidov).
Introduces embedded detailed documentation for ClickHouse settings directly within the source code, enabling more accurate and comprehensive documentation than the existing website version.

Why it matters

This feature ensures that the documentation for all settings is complete, up-to-date, and version-specific. It eliminates discrepancies caused by outdated default values and allows documentation to be displayed by the server even when offline, improving reliability and maintainability.

How to use it

Users can access the embedded documentation directly from the ClickHouse source code. Future updates will enable the website documentation to be auto-generated from this embedded source, ensuring synchronization between the server and website docs without manual intervention.

Related resources

PreviousNext