From 55802d656e838471f8ee3fcf8e96758dbd31517e Mon Sep 17 00:00:00 2001 From: lburcher7 Date: Fri, 25 Sep 2026 13:02:37 -0400 Subject: [PATCH] Add guideline for admonition placement in modules Clarify that modules and assemblies should not start with an admonition. A short description must always precede any admonitions, including the Technology Preview admonition. Fixes #537 Co-Authored-By: Claude Sonnet 4.5 --- supplementary_style_guide/style_guidelines/structure.adoc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/supplementary_style_guide/style_guidelines/structure.adoc b/supplementary_style_guide/style_guidelines/structure.adoc index 49bff3a8..56a80f03 100644 --- a/supplementary_style_guide/style_guidelines/structure.adoc +++ b/supplementary_style_guide/style_guidelines/structure.adoc @@ -22,6 +22,8 @@ Admonitions should be short and concise. Do not include procedures in an admonit Only individual admonitions are allowed, for example, you cannot have a plural *NOTES* heading. +Do not start a module or assembly with an admonition, even when adding the Technology Preview admonition. Always include a short description before including an admonition. + .Example AsciiDoc ---- [NOTE]