Skip to content

Commit 1b65393

Browse files
authored
Merge pull request #118 from LLM-Coding/copilot/improve-anchor-description-formatting
Convert anchor section labels to proper AsciiDoc section headers
2 parents 1f1b009 + b098ec6 commit 1b65393

File tree

95 files changed

+269
-263
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

95 files changed

+269
-263
lines changed

docs/anchors/_template.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
====
1010
Also known as:: Alternative Name, Other Name
1111

12-
*Core Concepts*:
12+
== *Core Concepts*:
1313

1414
Concept 1:: Brief description of concept 1
1515

@@ -19,13 +19,13 @@ Concept 3:: Brief description of concept 3
1919

2020
Key Proponents:: Author Name ("Book Title"), Another Author
2121

22-
*When to Use*:
22+
== *When to Use*:
2323

2424
* Use case 1
2525
* Use case 2
2626
* Use case 3
2727

28-
*Related Anchors*:
28+
== *Related Anchors*:
2929

3030
* <<related-anchor-1,Related Anchor Name>>
3131
* <<related-anchor-2,Another Related Anchor>>

docs/anchors/adr-according-to-nygard.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
====
77
Full Name:: Architecture Decision Records according to Michael Nygard
88

9-
*Core Concepts*:
9+
== *Core Concepts*:
1010

1111
Lightweight documentation:: Short, focused records
1212

@@ -27,7 +27,7 @@ Evolutionary architecture:: Supporting architecture that changes over time
2727

2828
Key Proponent:: Michael Nygard
2929

30-
*When to Use*:
30+
== *When to Use*:
3131

3232
* All software projects (low overhead, high value)
3333
* Distributed teams needing shared understanding

docs/anchors/adr-according-to-nygard.de.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
====
77
Vollständiger Name:: Architecture Decision Records nach Michael Nygard
88

9-
*Kernkonzepte*:
9+
== *Kernkonzepte*:
1010

1111
Leichtgewichtige Dokumentation:: Kurze, fokussierte Aufzeichnungen
1212

@@ -28,7 +28,7 @@ Evolutionäre Architektur:: Unterstützung von Architektur, die sich im Laufe de
2828

2929
Schlüsselvertreter:: Michael Nygard
3030

31-
*Wann zu verwenden*:
31+
== *Wann zu verwenden*:
3232

3333
* Alle Softwareprojekte (geringer Aufwand, hoher Wert)
3434
* Verteilte Teams, die gemeinsames Verständnis benötigen

docs/anchors/arc42.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
====
88
Full Name:: arc42 Architecture Documentation Template
99

10-
*Core Concepts*:
10+
== *Core Concepts*:
1111

1212
12 standardized sections:: From introduction to glossary
1313

@@ -41,7 +41,7 @@ Multiple formats:: AsciiDoc, Markdown, Confluence, etc.
4141

4242
Key Proponents:: Gernot Starke, Peter Hruschka
4343

44-
*When to Use*:
44+
== *When to Use*:
4545

4646
* Medium to large software projects
4747
* When stakeholder communication is critical

docs/anchors/arc42.de.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
====
88
Vollständiger Name:: arc42 Architekturdokumentations-Template
99

10-
*Kernkonzepte*:
10+
== *Kernkonzepte*:
1111

1212
12 standardisierte Abschnitte:: Von Einführung bis Glossar
1313

@@ -42,7 +42,7 @@ Mehrere Formate:: AsciiDoc, Markdown, Confluence, etc.
4242

4343
Schlüsselvertreter:: Gernot Starke, Peter Hruschka
4444

45-
*Wann zu verwenden*:
45+
== *Wann zu verwenden*:
4646

4747
* Mittlere bis große Softwareprojekte
4848
* Wenn Stakeholder-Kommunikation kritisch ist

docs/anchors/bem-methodology.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
====
88
Full Name:: Block Element Modifier (BEM) (S)CSS Methodology
99

10-
*Core Concepts*:
10+
== *Core Concepts*:
1111

1212
Motivation:: Solve CSS specificity wars, naming conflicts, and stylesheet maintainability issues in large codebases
1313

@@ -32,15 +32,15 @@ Mix:: Combining multiple BEM entities on a single DOM node
3232
File structure:: Often paired with component-based file organization
3333

3434

35-
*Naming Examples*:
35+
== *Naming Examples*:
3636

3737
* Block: `.search-form`
3838
* Element: `.search-form__input`, `.search-form__button`
3939
* Modifier: `.search-form--compact`, `.search-form__button--disabled`
4040

4141
Key Proponents:: Yandex development team
4242

43-
*When to Use*:
43+
== *When to Use*:
4444

4545
* Large-scale web applications with many components
4646
* Team projects requiring consistent (S)CSS naming conventions

docs/anchors/bem-methodology.de.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
====
88
Vollständiger Name:: Block Element Modifier (BEM) (S)CSS-Methodologie
99

10-
*Kernkonzepte*:
10+
== *Kernkonzepte*:
1111

1212
Motivation:: CSS-Spezifitätskriege, Namenskonflikte und Stylesheet-Wartbarkeitsprobleme in großen Codebasen lösen
1313

@@ -32,15 +32,15 @@ Mix:: Kombination mehrerer BEM-Entitäten auf einem einzigen DOM-Knoten
3232
Dateistruktur:: Oft gepaart mit komponentenbasierter Dateiorganisation
3333

3434

35-
*Benennungsbeispiele*:
35+
== *Benennungsbeispiele*:
3636

3737
* Block: `.search-form`
3838
* Element: `.search-form__input`, `.search-form__button`
3939
* Modifier: `.search-form--compact`, `.search-form__button--disabled`
4040

4141
Schlüsselvertreter:: Yandex Entwicklungsteam
4242

43-
*Wann zu verwenden*:
43+
== *Wann zu verwenden*:
4444

4545
* Großangelegte Webanwendungen mit vielen Komponenten
4646
* Teamprojekte, die konsistente (S)CSS-Namenskonventionen erfordern

docs/anchors/bluf.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Full Name:: BLUF (Bottom Line Up Front)
99

1010
Also known as:: Direct Answer Format, Conclusion-First Communication
1111

12-
*Core Concepts*:
12+
== *Core Concepts*:
1313

1414
Conclusion First:: State the main point, decision, or recommendation immediately
1515

@@ -32,7 +32,7 @@ Key Proponents:: US Military (Army writing standards), adopted broadly in busine
3232

3333
Historical Context:: Standardized in military communication where rapid decision-making is critical; now standard in business writing (McKinsey, consulting, executive communication)
3434

35-
*When to Use*:
35+
== *When to Use*:
3636

3737
* Executive summaries and briefings
3838
* Status reports to leadership
@@ -41,7 +41,7 @@ Historical Context:: Standardized in military communication where rapid decision
4141
* Any high-stakes communication where the reader needs the conclusion first
4242
* Technical documentation for time-constrained readers
4343

44-
*Relationship to Other Anchors*:
44+
== *Relationship to Other Anchors*:
4545

4646
* Related to <<pyramid-principle,Pyramid Principle>> but more narrowly focused on conclusion-first structure
4747
* Complements MECE by providing the organizational principle for grouped information

docs/anchors/bluf.de.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Vollständiger Name:: BLUF (Bottom Line Up Front - Das Wichtigste zuerst)
99

1010
Auch bekannt als:: Direkte Antwortformat, Schlussfolgerung-zuerst-Kommunikation
1111

12-
*Kernkonzepte*:
12+
== *Kernkonzepte*:
1313

1414
Schlussfolgerung zuerst:: Nennen Sie den Hauptpunkt, die Entscheidung oder Empfehlung sofort
1515

@@ -32,7 +32,7 @@ Schlüsselvertreter:: US-Militär (Army writing standards), weithin in Wirtschaf
3232

3333
Historischer Kontext:: Standardisiert in militärischer Kommunikation, wo schnelle Entscheidungsfindung kritisch ist; jetzt Standard im Business Writing (McKinsey, Consulting, Führungskommunikation)
3434

35-
*Wann zu verwenden*:
35+
== *Wann zu verwenden*:
3636

3737
* Executive Summaries und Briefings
3838
* Statusberichte an Führungskräfte
@@ -41,7 +41,7 @@ Historischer Kontext:: Standardisiert in militärischer Kommunikation, wo schnel
4141
* Jede hochkritische Kommunikation, bei der der Leser die Schlussfolgerung zuerst benötigt
4242
* Technische Dokumentation für zeitbeschränkte Leser
4343

44-
*Beziehung zu anderen Ankern*:
44+
== *Beziehung zu anderen Ankern*:
4545

4646
* Verwandt mit dem <<pyramid-principle,Pyramid Principle>>, aber enger auf die Schlussfolgerung-zuerst-Struktur fokussiert
4747
* Ergänzt MECE durch Bereitstellung des Organisationsprinzips für gruppierte Informationen

docs/anchors/c4-diagrams.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
====
77
Full Name:: C4 Model for Software Architecture Diagrams
88

9-
*Core Concepts*:
9+
== *Core Concepts*:
1010

1111
Four levels of abstraction::
1212
+
@@ -26,7 +26,7 @@ Supplementary diagrams:: Deployment, dynamic views, etc.
2626

2727
Key Proponent:: Simon Brown
2828

29-
*When to Use*:
29+
== *When to Use*:
3030

3131
* Communicating architecture to diverse stakeholders
3232
* Onboarding new team members

0 commit comments

Comments
 (0)