Skip to content

Commit 038448a

Browse files
authored
Merge pull request #134 from Preeticp/prerequisite_recommendation
Recommendation to use second level heading syntax for assembly-level prerequisites
2 parents ce8b529 + cd45dc9 commit 038448a

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

modular-docs-manual/content/topics/module_guidelines-assembly.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ Consider rewording the user story to write the assembly introduction, for exampl
1616
[discrete]
1717
== Assembly Prerequisites
1818

19-
Prerequisites are conditions that must be satisfied before the user can start following the assembly.
19+
Prerequisites are conditions that must be satisfied before the user can start following the assembly and are applicable to all the modules in the assembly.
20+
21+
Use the second level heading syntax for the Prerequisites section in the assembly so that it is displayed in the table of contents and is consistent with the Additional resources or Next steps sections in the assembly.
2022

2123
// [bhardest] - We have a lot of xref-ing in these guidelines. A better approach might be to create a "snippets" .adoc file with snippets of common content (for example, the content about writing prerequisites, which applies to multiple sections). Then we can just include the relevant content from the snippets file wherever it's needed.
2224
// [asteflova] - Let's do this after we finish reviewing the guidelines for procedures and assemblies.

modular-docs-manual/files/TEMPLATE_ASSEMBLY_a-collection-of-modules.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ The `context` attribute enables module reuse. Every module ID includes {context}
3434
[role="_abstract"]
3535
This paragraph is the assembly introduction. It explains what the user will accomplish by working through the modules in the assembly and sets the context for the user story the assembly is based on. The text that immediately follows the `[role="_abstract"]` tag is used for search metadata.
3636
37-
.Prerequisites
37+
== Prerequisites
3838
3939
* A bulleted list of conditions that must be satisfied before the user starts following this assembly.
4040
* You can also link to other modules or assemblies the user must follow before starting this assembly.

0 commit comments

Comments
 (0)