Skip to content

Commit 745ccc2

Browse files
author
Bob Furu
authored
Merge pull request #35730 from bobfuru/fix-contrib
2 parents 2675358 + 2437062 commit 745ccc2

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

contributing_to_docs/doc_guidelines.adoc

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

230230
[NOTE]
231231
====
232-
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.
232+
When using the "Prerequisites", "Next steps", or "Additional resources" headings in an assembly, use `==` formatting, such as `== Prerequisites` or `== Additional resources`. Use of this heading syntax at the assembly level indicates that the sections relate to the whole assembly.
233+
234+
Only use `.` formatting (`.Additional resources`) to follow a module in an assembly. Because you cannot use the xrefs in modules, this functions as a _trailing include_ at the assembly level, where the `.` formatting of the `include` statement indicates that the resource applies specifically to the module and not to the assembly.
233235
====
234236

235237
== Writing concepts
@@ -254,7 +256,7 @@ link:https://redhat-documentation.github.io/modular-docs/#creating-procedure-mod
254256

255257
[NOTE]
256258
====
257-
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.
259+
When needed, use `.Prerequisites`, `.Next steps`, or `.Additional resources` syntax to suppress TOC formatting within a module. Do not use `==` syntax for these headings in modules. Because you cannot use the xrefs in modules, if you need to include a link under one of these headings, place the entire subsection in the assembly instead.
258260
====
259261

260262
[id="using-conscious-language"]

0 commit comments

Comments
 (0)