Skip to content

Commit b2d129f

Browse files
author
Bob Furu
authored
Merge pull request #30125 from bobfuru/fix-25072
Minor fix for clarity after PR25072
2 parents 70177ee + 2290c66 commit b2d129f

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

contributing_to_docs/doc_guidelines.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ link:https://redhat-documentation.github.io/modular-docs/#forming-assemblies[Red
130130

131131
[NOTE]
132132
====
133-
For `Prerequisites`, `Next steps`, and `Additional resources` headings, use `==` formatting in assembly files. Do not use `.Prerequisites`, `.Next steps`, or `.Additional information`, as this syntax should only be used within module files to suppress TOC formatting.
133+
When using `Prerequisites`, `Next steps`, and `Additional resources` headings in an assembly, use `==` formatting, such as `== Prerequisites` and `== Additional resources`. Use of this heading syntax at the assembly level indicates that the sections relate to the whole assembly. Only use `.` syntax (`.Additional resources`) to follow the module as a trailing include at the assembly level, which indicates that the resources apply specifically to the module.
134134
====
135135

136136
== Writing concepts
@@ -155,7 +155,7 @@ link:https://redhat-documentation.github.io/modular-docs/#creating-procedure-mod
155155

156156
[NOTE]
157157
====
158-
When needed, use `.Prerequisites`, `.Next steps`, or `.Additional information` syntax to suppress TOC formatting within a module. Do not use `==` headings or xrefs in modules.
158+
When needed, use `.Prerequisites`, `.Next steps`, or `.Additional resources` syntax to suppress TOC formatting within a module. Do not use `==` headings or xrefs in modules.
159159
====
160160

161161
== Product name & version

0 commit comments

Comments
 (0)