Skip to content

Commit 8c77a75

Browse files
authored
Merge pull request #250 from mjahoda/various-bug-fixes
Various bug fixes
2 parents d867e4f + a655a43 commit 8c77a75

3 files changed

Lines changed: 15 additions & 10 deletions

File tree

modular-docs-manual/content/topics/creating_procedure_modules.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[id="con-creating-procedure-modules_{context}"]
1+
[id="con-creating-procedure-modules"]
22

33
= Procedure modules
44

modular-docs-manual/content/topics/introduction.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[id="introduction_{context}"]
1+
[id="introduction"]
22
= Introduction to modular documentation
33

44
This manual provides instructions on how to author modularly structured documentation based on user stories. The manual defines used terminology, describes components that form modular documentation, and instructs writers on how to use provided templates to turn user stories into modular documentation.

modular-docs-manual/content/topics/whats-new.adoc

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[id="whats-new_{context}"]
1+
[id="whats-new"]
22
= What's new
33

44
The following list summarizes significant changes to the modular documentation standard over time.
@@ -14,24 +14,29 @@ For a complete list of changes, see link:https://github.com/redhat-documentation
1414
[discrete]
1515
== 2026: February
1616

17-
* Removed references the Next steps section from the assembly guidelines and template to avoid a confusing order in DITA.
17+
* Removed the Next steps section from the assembly guidelines and template to avoid a confusing order in DITA.
1818

1919
[discrete]
2020
== 2025: October
2121

22-
* Removed references to the [discrete] tag for concept and reference modules.
22+
* Removed references to the `[discrete]` tag for concept and reference modules.
2323
* Updated the optional sections in the Procedure module section.
2424

25+
[discrete]
26+
== 2025: September
27+
28+
* Re-introduced the `[role="_abstract"]` tag in the templates to mark a paragraph containing a DITA-compatible short description.
29+
2530
[discrete]
2631
== 2025: April
2732

28-
* Removed 'Limitations' section from the Procedure section.
29-
* Updated the comments in the templates to provide guidance to prepare for migration to DITA.
33+
* Removed the *Limitations* section from the Procedure section.
34+
* Updated comments in the templates to guide migration preparations to DITA.
3035

3136
[discrete]
3237
== 2024: January
3338

34-
* Removed the `*[role="_abstract"]*` tag from the templates (regression).
39+
* Removed the `[role="_abstract"]` tag from the templates (regression).
3540
link:https://github.com/redhat-documentation/modular-docs/pull/222[#222]
3641

3742
[discrete]
@@ -64,7 +69,7 @@ link:https://github.com/redhat-documentation/modular-docs/pull/201[#201]
6469
[discrete]
6570
== 2022: September
6671

67-
* Added a guidance for *assembly titles*.
72+
* Added guidance for *assembly titles*.
6873
link:https://github.com/redhat-documentation/modular-docs/pull/192[#192]
6974

7075
[discrete]
@@ -100,7 +105,7 @@ link:https://github.com/redhat-documentation/modular-docs/pull/150[#150]
100105
[discrete]
101106
== 2021: June
102107

103-
* Added a guidance for *text snippets* and a convention that *modules should not contain other modules*.
108+
* Added guidance for *text snippets* and a convention that *modules should not contain other modules*.
104109
link:https://github.com/redhat-documentation/modular-docs/pull/161[#161]
105110

106111
[discrete]

0 commit comments

Comments
 (0)