Skip to content

Add guideline for admonition placement in modules #600

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
IngridT1 merged 1 commit into from
Sep 28, 2026
Merged

Add guideline for admonition placement in modules #600

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions supplementary_style_guide/style_guidelines/structure.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
Loading