Update the documentation; #1

msuchane · Jun 27, 2024 · 808b9cf · 808b9cf
1 parent 87a457c
commit 808b9cf
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/docs/modules/con_documentation-files-generated-from-templates.adoc b/docs/modules/con_documentation-files-generated-from-templates.adoc
@@ -28,12 +28,12 @@ ref___title-of-section__-__title-of-its-including-parent__.adoc
 
 * If no tickets in your project match the `filter` rules defined in this chapter or section, it does not generate any file.
 +
-You must remove or comment out the include statement to this file in your `main-template.adoc` file, otherwise `asciidoctor` reports an error when you compile the document.
+Top-level chapters are an exception to this rule. These chapters are generated even if they are empty of release notes, and in that case, they end up being completely empty files. This is a feature that ensures that include directives do not break in your main AsciiDoc file.
 +
 For example:
 
-** A _Known issues_ chapter uses a filter that looks for tickets with the `Known Issue` doc type. However, none of your tickets in this project is a `Known Issue`. As a result, the `assembly_known-issues.adoc` file is not generated.
+** A _Known issues_ chapter uses a filter that looks for tickets with the `Known Issue` doc type. However, none of your tickets in this project is a `Known Issue`. As a result, the `assembly_known-issues.adoc` file is generated as empty.
 
-** A chapter includes subsections that look for three specific components. However, none of your tickets belong to these components. As a result, neither the section modules nor the chapter assembly files are generated.
+** A chapter includes subsections that look for three specific components. However, none of your tickets belong to these components. As a result, the section modules are not generated, and the chapter assembly file is generated empty.
 
-** A chapter matches several tickets, the doc text status of all the tickets is incomplete. As a result, the file is generated for the `internal` version of the document, but not for the `external` version.
+** A chapter matches several tickets, the doc text status of all the tickets is incomplete. As a result, the file is generated for the `internal` version of the document with the release note content, but in the `external` version, it is an empty file.