diff --git a/.hyperlint/reviewer/custom-style-guide/code-formatting.adoc b/.hyperlint/reviewer/custom-style-guide/code-formatting.adoc index 47f42056d..6bb0e3cbc 100644 --- a/.hyperlint/reviewer/custom-style-guide/code-formatting.adoc +++ b/.hyperlint/reviewer/custom-style-guide/code-formatting.adoc @@ -31,3 +31,8 @@ xref:api:ROOT:admin-api.adoc#get-/v1/broker/pre_restart_probe[`pre_restart_probe ---- This version is incorrect because it starts directly with the xref. According to our style guidelines, sentences should not begin with a command, code snippet, or filename. Instead, the xref should be integrated into a descriptive sentence. + + +== AsciiDoc include directives + +Do NOT make comments on lines that start with `include::`, this just allows us to import other files.