Back to all reviewers

Documentation completeness standards

ClickHouse/ClickHouse
Based on 3 comments
Markdown

Ensure all documentation meets completeness and formatting standards. This includes: (1) Adding language specifications to all fenced code blocks to satisfy linting requirements, (2) Including deprecation notes with clear migration guidance when removing or replacing features, and (3) Following established documentation patterns and embedding guidelines.

Documentation Markdown

Reviewer Prompt

Ensure all documentation meets completeness and formatting standards. This includes: (1) Adding language specifications to all fenced code blocks to satisfy linting requirements, (2) Including deprecation notes with clear migration guidance when removing or replacing features, and (3) Following established documentation patterns and embedding guidelines.

For code blocks, always specify the language:

DESC format(JSONEachRow, '{"arr" : [42, "hello", [1, 2, 3]]}');

For deprecated features, provide clear migration paths:

system.latency_log was deprecated after version 25.x, instead system.histogram_metrics should be used

Consider embedding documentation directly in code when appropriate, as this keeps documentation close to implementation and reduces maintenance overhead.

3
Comments Analyzed
Markdown
Primary Language
Documentation
Category

Source Discussions