diff --git a/arc42/01_introduction_and_goals.html b/arc42/01_introduction_and_goals.html
index 932b36f..604fdc9 100644
--- a/arc42/01_introduction_and_goals.html
+++ b/arc42/01_introduction_and_goals.html
@@ -216,6 +216,10 @@
                 <a class="nav-link active" href="../arc42/index.html"><span>arc42</span></a>
             </li>
 
+            <li class="nav-item mr-4 mb-2 mb-lg-0">
+                <a class="nav-link " href="../readme/README.html"><span>readme</span></a>
+            </li>
+
             <li class="nav-item mr-4 mb-2 mb-lg-0">
                 <a class="nav-link " href="../canvas/architecture-canvas.html"><span>canvas</span></a>
             </li>
diff --git a/arc42/02_architecture_constraints.html b/arc42/02_architecture_constraints.html
index faf9407..f3081ea 100644
--- a/arc42/02_architecture_constraints.html
+++ b/arc42/02_architecture_constraints.html
@@ -216,6 +216,10 @@
                 <a class="nav-link active" href="../arc42/index.html"><span>arc42</span></a>
             </li>
 
+            <li class="nav-item mr-4 mb-2 mb-lg-0">
+                <a class="nav-link " href="../readme/README.html"><span>readme</span></a>
+            </li>
+
             <li class="nav-item mr-4 mb-2 mb-lg-0">
                 <a class="nav-link " href="../canvas/architecture-canvas.html"><span>canvas</span></a>
             </li>
diff --git a/arc42/03_system_scope_and_context.html b/arc42/03_system_scope_and_context.html
index 788b0df..ebecb9c 100644
--- a/arc42/03_system_scope_and_context.html
+++ b/arc42/03_system_scope_and_context.html
@@ -216,6 +216,10 @@
                 <a class="nav-link active" href="../arc42/index.html"><span>arc42</span></a>
             </li>
 
+            <li class="nav-item mr-4 mb-2 mb-lg-0">
+                <a class="nav-link " href="../readme/README.html"><span>readme</span></a>
+            </li>
+
             <li class="nav-item mr-4 mb-2 mb-lg-0">
                 <a class="nav-link " href="../canvas/architecture-canvas.html"><span>canvas</span></a>
             </li>
diff --git a/arc42/04_solution_strategy.html b/arc42/04_solution_strategy.html
index 700cfe8..dc59d81 100644
--- a/arc42/04_solution_strategy.html
+++ b/arc42/04_solution_strategy.html
@@ -216,6 +216,10 @@
                 <a class="nav-link active" href="../arc42/index.html"><span>arc42</span></a>
             </li>
 
+            <li class="nav-item mr-4 mb-2 mb-lg-0">
+                <a class="nav-link " href="../readme/README.html"><span>readme</span></a>
+            </li>
+
             <li class="nav-item mr-4 mb-2 mb-lg-0">
                 <a class="nav-link " href="../canvas/architecture-canvas.html"><span>canvas</span></a>
             </li>
diff --git a/arc42/05_building_block_view.html b/arc42/05_building_block_view.html
index 0a2c8c0..e65835c 100644
--- a/arc42/05_building_block_view.html
+++ b/arc42/05_building_block_view.html
@@ -216,6 +216,10 @@
                 <a class="nav-link active" href="../arc42/index.html"><span>arc42</span></a>
             </li>
 
+            <li class="nav-item mr-4 mb-2 mb-lg-0">
+                <a class="nav-link " href="../readme/README.html"><span>readme</span></a>
+            </li>
+
             <li class="nav-item mr-4 mb-2 mb-lg-0">
                 <a class="nav-link " href="../canvas/architecture-canvas.html"><span>canvas</span></a>
             </li>
diff --git a/arc42/06_runtime_view.html b/arc42/06_runtime_view.html
index ec8c5b5..59ff8a9 100644
--- a/arc42/06_runtime_view.html
+++ b/arc42/06_runtime_view.html
@@ -216,6 +216,10 @@
                 <a class="nav-link active" href="../arc42/index.html"><span>arc42</span></a>
             </li>
 
+            <li class="nav-item mr-4 mb-2 mb-lg-0">
+                <a class="nav-link " href="../readme/README.html"><span>readme</span></a>
+            </li>
+
             <li class="nav-item mr-4 mb-2 mb-lg-0">
                 <a class="nav-link " href="../canvas/architecture-canvas.html"><span>canvas</span></a>
             </li>
diff --git a/arc42/07_deployment_view.html b/arc42/07_deployment_view.html
index 419f4d1..8bc9799 100644
--- a/arc42/07_deployment_view.html
+++ b/arc42/07_deployment_view.html
@@ -216,6 +216,10 @@
                 <a class="nav-link active" href="../arc42/index.html"><span>arc42</span></a>
             </li>
 
+            <li class="nav-item mr-4 mb-2 mb-lg-0">
+                <a class="nav-link " href="../readme/README.html"><span>readme</span></a>
+            </li>
+
             <li class="nav-item mr-4 mb-2 mb-lg-0">
                 <a class="nav-link " href="../canvas/architecture-canvas.html"><span>canvas</span></a>
             </li>
diff --git a/arc42/08_concepts.html b/arc42/08_concepts.html
index 2bf0722..db5bd48 100644
--- a/arc42/08_concepts.html
+++ b/arc42/08_concepts.html
@@ -216,6 +216,10 @@
                 <a class="nav-link active" href="../arc42/index.html"><span>arc42</span></a>
             </li>
 
+            <li class="nav-item mr-4 mb-2 mb-lg-0">
+                <a class="nav-link " href="../readme/README.html"><span>readme</span></a>
+            </li>
+
             <li class="nav-item mr-4 mb-2 mb-lg-0">
                 <a class="nav-link " href="../canvas/architecture-canvas.html"><span>canvas</span></a>
             </li>
diff --git a/arc42/09_architecture_decisions.html b/arc42/09_architecture_decisions.html
index 3f927e2..eab9443 100644
--- a/arc42/09_architecture_decisions.html
+++ b/arc42/09_architecture_decisions.html
@@ -216,6 +216,10 @@
                 <a class="nav-link active" href="../arc42/index.html"><span>arc42</span></a>
             </li>
 
+            <li class="nav-item mr-4 mb-2 mb-lg-0">
+                <a class="nav-link " href="../readme/README.html"><span>readme</span></a>
+            </li>
+
             <li class="nav-item mr-4 mb-2 mb-lg-0">
                 <a class="nav-link " href="../canvas/architecture-canvas.html"><span>canvas</span></a>
             </li>
diff --git a/arc42/10_quality_requirements.html b/arc42/10_quality_requirements.html
index 368fce6..1c015ad 100644
--- a/arc42/10_quality_requirements.html
+++ b/arc42/10_quality_requirements.html
@@ -216,6 +216,10 @@
                 <a class="nav-link active" href="../arc42/index.html"><span>arc42</span></a>
             </li>
 
+            <li class="nav-item mr-4 mb-2 mb-lg-0">
+                <a class="nav-link " href="../readme/README.html"><span>readme</span></a>
+            </li>
+
             <li class="nav-item mr-4 mb-2 mb-lg-0">
                 <a class="nav-link " href="../canvas/architecture-canvas.html"><span>canvas</span></a>
             </li>
diff --git a/arc42/11_technical_risks.html b/arc42/11_technical_risks.html
index 08b6910..0f068c0 100644
--- a/arc42/11_technical_risks.html
+++ b/arc42/11_technical_risks.html
@@ -216,6 +216,10 @@
                 <a class="nav-link active" href="../arc42/index.html"><span>arc42</span></a>
             </li>
 
+            <li class="nav-item mr-4 mb-2 mb-lg-0">
+                <a class="nav-link " href="../readme/README.html"><span>readme</span></a>
+            </li>
+
             <li class="nav-item mr-4 mb-2 mb-lg-0">
                 <a class="nav-link " href="../canvas/architecture-canvas.html"><span>canvas</span></a>
             </li>
diff --git a/arc42/12_glossary.html b/arc42/12_glossary.html
index fd7bece..55ba849 100644
--- a/arc42/12_glossary.html
+++ b/arc42/12_glossary.html
@@ -216,6 +216,10 @@
                 <a class="nav-link active" href="../arc42/index.html"><span>arc42</span></a>
             </li>
 
+            <li class="nav-item mr-4 mb-2 mb-lg-0">
+                <a class="nav-link " href="../readme/README.html"><span>readme</span></a>
+            </li>
+
             <li class="nav-item mr-4 mb-2 mb-lg-0">
                 <a class="nav-link " href="../canvas/architecture-canvas.html"><span>canvas</span></a>
             </li>
diff --git a/arc42/index.html b/arc42/index.html
index 88a4566..c9670fe 100644
--- a/arc42/index.html
+++ b/arc42/index.html
@@ -216,6 +216,10 @@
                 <a class="nav-link active" href="../arc42/index.html"><span>arc42</span></a>
             </li>
 
+            <li class="nav-item mr-4 mb-2 mb-lg-0">
+                <a class="nav-link " href="../readme/README.html"><span>readme</span></a>
+            </li>
+
             <li class="nav-item mr-4 mb-2 mb-lg-0">
                 <a class="nav-link " href="../canvas/architecture-canvas.html"><span>canvas</span></a>
             </li>
diff --git a/archive.html b/archive.html
index 5748c5a..be572a4 100644
--- a/archive.html
+++ b/archive.html
@@ -213,6 +213,10 @@
                 <a class="nav-link " href="arc42/index.html"><span>arc42</span></a>
             </li>
 
+            <li class="nav-item mr-4 mb-2 mb-lg-0">
+                <a class="nav-link " href="readme/README.html"><span>readme</span></a>
+            </li>
+
             <li class="nav-item mr-4 mb-2 mb-lg-0">
                 <a class="nav-link " href="canvas/architecture-canvas.html"><span>canvas</span></a>
             </li>
diff --git a/canvas/architecture-canvas.html b/canvas/architecture-canvas.html
index 1e5f19a..25c4ed9 100644
--- a/canvas/architecture-canvas.html
+++ b/canvas/architecture-canvas.html
@@ -216,6 +216,10 @@
                 <a class="nav-link " href="../arc42/index.html"><span>arc42</span></a>
             </li>
 
+            <li class="nav-item mr-4 mb-2 mb-lg-0">
+                <a class="nav-link " href="../readme/README.html"><span>readme</span></a>
+            </li>
+
             <li class="nav-item mr-4 mb-2 mb-lg-0">
                 <a class="nav-link active" href="../canvas/architecture-canvas.html"><span>canvas</span></a>
             </li>
diff --git a/feed.xml b/feed.xml
index f46ea30..db36577 100644
--- a/feed.xml
+++ b/feed.xml
@@ -6,8 +6,8 @@
     <atom:link href="http://jbake.org/feed.xml" rel="self" type="application/rss+xml" />
     <description>JBake Bootstrap Template</description>
     <language>en-gb</language>
-    <pubDate>Wed, 27 Nov 2024 10:30:53 +0000</pubDate>
-    <lastBuildDate>Wed, 27 Nov 2024 10:30:53 +0000</lastBuildDate>
+    <pubDate>Wed, 27 Nov 2024 10:35:25 +0000</pubDate>
+    <lastBuildDate>Wed, 27 Nov 2024 10:35:25 +0000</lastBuildDate>
 
     
 
diff --git a/index.html b/index.html
index 1b540ab..93f3651 100644
--- a/index.html
+++ b/index.html
@@ -216,6 +216,10 @@
                 <a class="nav-link " href="arc42/index.html"><span>arc42</span></a>
             </li>
 
+            <li class="nav-item mr-4 mb-2 mb-lg-0">
+                <a class="nav-link " href="readme/README.html"><span>readme</span></a>
+            </li>
+
             <li class="nav-item mr-4 mb-2 mb-lg-0">
                 <a class="nav-link " href="canvas/architecture-canvas.html"><span>canvas</span></a>
             </li>
diff --git a/lunrjsindex.js b/lunrjsindex.js
index 1e50786..d2a4fdf 100644
--- a/lunrjsindex.js
+++ b/lunrjsindex.js
@@ -10,6 +10,14 @@ var documents = [
 
 {
     "id": 1,
+    "uri": "readme/README.html",
+    "menu": "readme",
+    "title": "README.adoc",
+    "text": " Unresolved directive in &lt;stdin&gt; - include::../../README.adoc[] "
+},
+
+{
+    "id": 2,
     "uri": "arc42/08_concepts.html",
     "menu": "arc42",
     "title": "Cross-cutting Concepts",
@@ -17,7 +25,7 @@ var documents = [
 },
 
 {
-    "id": 2,
+    "id": 3,
     "uri": "arc42/07_deployment_view.html",
     "menu": "arc42",
     "title": "Deployment View",
@@ -25,7 +33,7 @@ var documents = [
 },
 
 {
-    "id": 3,
+    "id": 4,
     "uri": "arc42/11_technical_risks.html",
     "menu": "arc42",
     "title": "Technical Risks and Technical Debt",
@@ -33,7 +41,7 @@ var documents = [
 },
 
 {
-    "id": 4,
+    "id": 5,
     "uri": "arc42/05_building_block_view.html",
     "menu": "arc42",
     "title": "Building Block View",
@@ -41,7 +49,15 @@ var documents = [
 },
 
 {
-    "id": 5,
+    "id": 6,
+    "uri": "arc42/index.html",
+    "menu": "arc42",
+    "title": "AsciiDoc Linter Architecture Documentation",
+    "text": " Table of Contents AsciiDoc Linter Architecture Documentation Introduction and Goals Requirements Overview Quality Goals Stakeholders Architecture Constraints Technical Constraints Organizational Constraints Conventions System Scope and Context Business Context Technical Context Solution Strategy Quality Goals and Architectural Approaches Technology Decisions Implementation Patterns Building Block View Level 1 - System Overview Level 2 - Core Components Level 3 - Rule Implementation Runtime View Document Processing Sequence Rule Loading Sequence Error Reporting Sequence Deployment View Infrastructure Level 1 Technical Infrastructure Security and Access Cross-cutting Concepts Domain Concepts Security Concepts Authentication and Authorization Input Validation Output Sanitization Development Concepts Test Strategy Release Process Configuration Concepts Rule Configuration Plugin System Architecture Decisions ADR 1: Rule Base Class Design Status Context Decision Consequences ADR 2: Finding Data Structure Status Context Decision Consequences ADR 3: Rule Implementation Strategy Status Context Decision Consequences ADR 4: Test Strategy Status Context Decision Consequences Quality Requirements Quality Scenarios Performance Scenarios Reliability Scenarios Usability Scenarios Quality Tree Technical Risks and Technical Debt Risk Analysis Technical Debt Current Technical Debt Planned Improvements Risk Matrix Glossary AsciiDoc Linter Architecture Documentation Introduction and Goals Requirements Overview The AsciiDoc Linter is a tool designed to ensure consistent formatting and structure in AsciiDoc documents. It helps teams maintain high-quality documentation by enforcing style rules and best practices. Key requirements include: Validate AsciiDoc heading structure Ensure consistent formatting Provide clear error messages Easy integration into existing workflows Extensible rule system Quality Goals Priority Quality Goal Motivation 1 Extensibility The system must be easily extensible with new rules to accommodate different documentation standards and requirements. 2 Reliability The linter must provide consistent and accurate results to maintain user trust. 3 Usability Error messages must be clear and actionable, helping users fix documentation issues efficiently. 4 Performance The linter should process documents quickly to maintain a smooth workflow. 5 Maintainability The code must be well-structured and documented to facilitate future enhancements. Stakeholders Role/Name Contact Expectations Documentation Writers various * Clear error messages * Consistent results * Quick feedback Documentation Maintainers various * Configurable rules * Reliable validation * Integration with existing tools Development Team dev team * Extensible architecture * Good test coverage * Clear documentation Technical Writers various * Support for AsciiDoc best practices * Customizable rule sets * Batch processing capabilities Architecture Constraints Technical Constraints Constraint Description Background Python 3.8+ The system must run on Python 3.8 or higher Need for modern language features and type hints Platform Independence Must run on Windows, Linux, and macOS Support for all major development platforms No External Dependencies Core functionality should work without external libraries Easy installation and deployment Memory Footprint Should process documents with minimal memory usage Support for large documentation projects Organizational Constraints Constraint Description Background Open Source Project must be open source under MIT license Community involvement and transparency Documentation All code must be documented with docstrings Maintainability and community contribution Test Coverage Minimum 90% test coverage required Quality assurance and reliability Version Control Git-based development with feature branches Collaborative development process Conventions Convention Description Background Code Style Follow PEP 8 guidelines Python community standards Type Hints Use type hints throughout the code Code clarity and IDE support Commit Messages Follow conventional commits specification Clear change history Documentation Format Use AsciiDoc for all documentation Dogfooding our own tool System Scope and Context Business Context Technical Context Solution Strategy Quality Goals and Architectural Approaches Quality Goal Solution Approach Details Extensibility * Abstract base classes * Plugin architecture * Clear interfaces * New rules can be added by extending base classes * Plugin system allows external rule packages * Well-defined interfaces for rule implementation Reliability * Comprehensive testing * Strong typing * Defensive programming * High test coverage * Type hints throughout the code * Careful input validation Usability * Clear error messages * Context information * Configuration options * Detailed error descriptions * Line and column information * Configurable rule severity Performance * Efficient algorithms * Lazy loading * Caching * Line-by-line processing * Rules loaded on demand * Cache parsing results Maintainability * Clean architecture * SOLID principles * Documentation * Clear separation of concerns * Single responsibility principle * Comprehensive documentation Technology Decisions Technology Decision Rationale Python Primary implementation language * Strong standard library * Great text processing capabilities * Wide adoption in tooling Regular Expressions Pattern matching * Built into Python * Efficient for text processing * Well understood by developers YAML Configuration format * Human readable * Standard format * Good library support unittest Testing framework * Part of Python standard library * Well known to developers * Good IDE support Implementation Patterns Building Block View Level 1 - System Overview Level 2 - Core Components Level 3 - Rule Implementation Runtime View Document Processing Sequence Rule Loading Sequence Error Reporting Sequence Deployment View Infrastructure Level 1 Technical Infrastructure Security and Access Cross-cutting Concepts Domain Concepts Security Concepts Authentication and Authorization Package distribution secured via PyPI authentication Configuration files with restricted access Signed releases with GPG keys Input Validation Strict content validation Safe file handling Memory usage limits Output Sanitization Escaped error messages Safe file paths handling Controlled error reporting Development Concepts Test Strategy Release Process Configuration Concepts Rule Configuration rules: heading_hierarchy: enabled: true severity: error options: max_level: 6 heading_format: enabled: true severity: warning options: require_space: true require_capitalization: true Plugin System Architecture Decisions ADR 1: Rule Base Class Design Status Accepted Context We need a flexible and extensible way to implement different linting rules for AsciiDoc documents. Decision We will use an abstract base class Rule with a defined interface that all concrete rules must implement. Consequences Positive Consistent interface for all rules Easy to add new rules Clear separation of concerns Simplified testing through common interface Negative Additional abstraction layer Slight performance overhead ADR 2: Finding Data Structure Status Accepted Context Rule violations need to be reported in a consistent and informative way. Decision We will use a Finding data class with fields for message, severity, position, rule ID, and context. Consequences Positive Structured error reporting Rich context for violations Consistent error format Negative More complex than simple string messages Requires more memory for storing findings ADR 3: Rule Implementation Strategy Status Accepted Context Rules need to process AsciiDoc content and identify violations efficiently. Decision Each rule will process the content line by line, using regular expressions for pattern matching. Consequences Positive Simple implementation Good performance for most cases Easy to understand and maintain Negative Limited context awareness May miss some complex patterns Regular expressions can become complex ADR 4: Test Strategy Status Accepted Context Rules need to be thoroughly tested to ensure reliable operation. Decision Each rule will have its own test class with multiple test methods covering various scenarios. Consequences Positive High test coverage Clear test organization Easy to add new test cases Negative More maintenance effort Longer test execution time :jbake-status: published :jbake-order: 10 :jbake-type: page_toc :jbake-menu: arc42 :jbake-title: Quality Requirements Quality Requirements Quality Scenarios Performance Scenarios Scenario Stimulus Response Priority Fast Document Processing Process 1000-line document Complete in &lt; 1 second High Multiple File Processing Process 100 documents Complete in &lt; 10 seconds Medium Memory Usage Process large document (10MB) Use &lt; 100MB RAM High Startup Time Launch linter Ready in &lt; 0.5 seconds Medium Reliability Scenarios Scenario Stimulus Response Priority Error Recovery Invalid input file Clear error message, continue with next file High Configuration Error Invalid rule configuration Detailed error message, use defaults High Plugin Failure Plugin crashes Isolate failure, continue with other rules Medium Resource Exhaustion System low on memory Graceful shutdown, save progress Medium Usability Scenarios Scenario Stimulus Response Priority Clear Error Messages Rule violation found Show file, line, and actionable message High Configuration Change rule settings Take effect without restart Medium Integration Use in CI pipeline Exit code reflects success/failure High Documentation Look up rule details Find explanation within 30 seconds Medium Quality Tree Technical Risks and Technical Debt Risk Analysis Risk Description Impact Probability Mitigation Performance Degradation Rule processing becomes slow with many rules High Medium * Profile rule execution * Implement rule caching * Optimize core algorithms Memory Leaks Long-running processes accumulate memory High Low * Regular memory profiling * Automated testing * Resource cleanup False Positives Rules report incorrect violations Medium High * Extensive test cases * User feedback system * Rule configuration options Plugin Conflicts Custom rules interfere with core rules Medium Medium * Plugin isolation * Version compatibility checks * Clear plugin API Technical Debt Current Technical Debt Area Description Impact Priority Test Coverage Some edge cases not covered Medium High Documentation Some advanced features poorly documented Medium Medium Error Handling Some error cases not specifically handled High High Configuration Hard-coded values that should be configurable Low Low Planned Improvements Risk Matrix Glossary Term Definition Additional Information AsciiDoc Lightweight markup language for documentation Similar to Markdown, but with more features for technical documentation Linter Tool that analyzes source code or text for potential errors Focuses on style, format, and structure issues Rule Individual check that validates specific aspects Can be enabled/disabled and configured Finding Result of a rule check indicating a potential issue Contains message, severity, and location information Severity Importance level of a finding ERROR, WARNING, or INFO Position Location in a document where an issue was found Contains line and optional column information Plugin Extension that adds additional functionality Can provide custom rules and configurations CI/CD Continuous Integration/Continuous Deployment Automated build, test, and deployment process PyPI Python Package Index Central repository for Python packages Virtual Environment Isolated Python runtime environment Manages project-specific dependencies Type Hints Python type annotations Helps with code understanding and static analysis Unit Test Test of individual components Ensures correct behavior of specific functions Integration Test Test of component interactions Verifies system behavior as a whole Coverage Measure of code tested by automated tests Usually expressed as percentage Technical Debt Development shortcuts that need future attention Balance between quick delivery and maintainability "
+},
+
+{
+    "id": 7,
     "uri": "arc42/10_quality_requirements.html",
     "menu": "arc42",
     "title": "Quality Requirements",
@@ -49,15 +65,15 @@ var documents = [
 },
 
 {
-    "id": 6,
-    "uri": "arc42/index.html",
+    "id": 8,
+    "uri": "arc42/12_glossary.html",
     "menu": "arc42",
-    "title": "AsciiDoc Linter Architecture Documentation",
-    "text": " Table of Contents AsciiDoc Linter Architecture Documentation Introduction and Goals Requirements Overview Quality Goals Stakeholders Architecture Constraints Technical Constraints Organizational Constraints Conventions System Scope and Context Business Context Technical Context Solution Strategy Quality Goals and Architectural Approaches Technology Decisions Implementation Patterns Building Block View Level 1 - System Overview Level 2 - Core Components Level 3 - Rule Implementation Runtime View Document Processing Sequence Rule Loading Sequence Error Reporting Sequence Deployment View Infrastructure Level 1 Technical Infrastructure Security and Access Cross-cutting Concepts Domain Concepts Security Concepts Authentication and Authorization Input Validation Output Sanitization Development Concepts Test Strategy Release Process Configuration Concepts Rule Configuration Plugin System Architecture Decisions ADR 1: Rule Base Class Design Status Context Decision Consequences ADR 2: Finding Data Structure Status Context Decision Consequences ADR 3: Rule Implementation Strategy Status Context Decision Consequences ADR 4: Test Strategy Status Context Decision Consequences Quality Requirements Quality Scenarios Performance Scenarios Reliability Scenarios Usability Scenarios Quality Tree Technical Risks and Technical Debt Risk Analysis Technical Debt Current Technical Debt Planned Improvements Risk Matrix Glossary AsciiDoc Linter Architecture Documentation Introduction and Goals Requirements Overview The AsciiDoc Linter is a tool designed to ensure consistent formatting and structure in AsciiDoc documents. It helps teams maintain high-quality documentation by enforcing style rules and best practices. Key requirements include: Validate AsciiDoc heading structure Ensure consistent formatting Provide clear error messages Easy integration into existing workflows Extensible rule system Quality Goals Priority Quality Goal Motivation 1 Extensibility The system must be easily extensible with new rules to accommodate different documentation standards and requirements. 2 Reliability The linter must provide consistent and accurate results to maintain user trust. 3 Usability Error messages must be clear and actionable, helping users fix documentation issues efficiently. 4 Performance The linter should process documents quickly to maintain a smooth workflow. 5 Maintainability The code must be well-structured and documented to facilitate future enhancements. Stakeholders Role/Name Contact Expectations Documentation Writers various * Clear error messages * Consistent results * Quick feedback Documentation Maintainers various * Configurable rules * Reliable validation * Integration with existing tools Development Team dev team * Extensible architecture * Good test coverage * Clear documentation Technical Writers various * Support for AsciiDoc best practices * Customizable rule sets * Batch processing capabilities Architecture Constraints Technical Constraints Constraint Description Background Python 3.8+ The system must run on Python 3.8 or higher Need for modern language features and type hints Platform Independence Must run on Windows, Linux, and macOS Support for all major development platforms No External Dependencies Core functionality should work without external libraries Easy installation and deployment Memory Footprint Should process documents with minimal memory usage Support for large documentation projects Organizational Constraints Constraint Description Background Open Source Project must be open source under MIT license Community involvement and transparency Documentation All code must be documented with docstrings Maintainability and community contribution Test Coverage Minimum 90% test coverage required Quality assurance and reliability Version Control Git-based development with feature branches Collaborative development process Conventions Convention Description Background Code Style Follow PEP 8 guidelines Python community standards Type Hints Use type hints throughout the code Code clarity and IDE support Commit Messages Follow conventional commits specification Clear change history Documentation Format Use AsciiDoc for all documentation Dogfooding our own tool System Scope and Context Business Context Technical Context Solution Strategy Quality Goals and Architectural Approaches Quality Goal Solution Approach Details Extensibility * Abstract base classes * Plugin architecture * Clear interfaces * New rules can be added by extending base classes * Plugin system allows external rule packages * Well-defined interfaces for rule implementation Reliability * Comprehensive testing * Strong typing * Defensive programming * High test coverage * Type hints throughout the code * Careful input validation Usability * Clear error messages * Context information * Configuration options * Detailed error descriptions * Line and column information * Configurable rule severity Performance * Efficient algorithms * Lazy loading * Caching * Line-by-line processing * Rules loaded on demand * Cache parsing results Maintainability * Clean architecture * SOLID principles * Documentation * Clear separation of concerns * Single responsibility principle * Comprehensive documentation Technology Decisions Technology Decision Rationale Python Primary implementation language * Strong standard library * Great text processing capabilities * Wide adoption in tooling Regular Expressions Pattern matching * Built into Python * Efficient for text processing * Well understood by developers YAML Configuration format * Human readable * Standard format * Good library support unittest Testing framework * Part of Python standard library * Well known to developers * Good IDE support Implementation Patterns Building Block View Level 1 - System Overview Level 2 - Core Components Level 3 - Rule Implementation Runtime View Document Processing Sequence Rule Loading Sequence Error Reporting Sequence Deployment View Infrastructure Level 1 Technical Infrastructure Security and Access Cross-cutting Concepts Domain Concepts Security Concepts Authentication and Authorization Package distribution secured via PyPI authentication Configuration files with restricted access Signed releases with GPG keys Input Validation Strict content validation Safe file handling Memory usage limits Output Sanitization Escaped error messages Safe file paths handling Controlled error reporting Development Concepts Test Strategy Release Process Configuration Concepts Rule Configuration rules: heading_hierarchy: enabled: true severity: error options: max_level: 6 heading_format: enabled: true severity: warning options: require_space: true require_capitalization: true Plugin System Architecture Decisions ADR 1: Rule Base Class Design Status Accepted Context We need a flexible and extensible way to implement different linting rules for AsciiDoc documents. Decision We will use an abstract base class Rule with a defined interface that all concrete rules must implement. Consequences Positive Consistent interface for all rules Easy to add new rules Clear separation of concerns Simplified testing through common interface Negative Additional abstraction layer Slight performance overhead ADR 2: Finding Data Structure Status Accepted Context Rule violations need to be reported in a consistent and informative way. Decision We will use a Finding data class with fields for message, severity, position, rule ID, and context. Consequences Positive Structured error reporting Rich context for violations Consistent error format Negative More complex than simple string messages Requires more memory for storing findings ADR 3: Rule Implementation Strategy Status Accepted Context Rules need to process AsciiDoc content and identify violations efficiently. Decision Each rule will process the content line by line, using regular expressions for pattern matching. Consequences Positive Simple implementation Good performance for most cases Easy to understand and maintain Negative Limited context awareness May miss some complex patterns Regular expressions can become complex ADR 4: Test Strategy Status Accepted Context Rules need to be thoroughly tested to ensure reliable operation. Decision Each rule will have its own test class with multiple test methods covering various scenarios. Consequences Positive High test coverage Clear test organization Easy to add new test cases Negative More maintenance effort Longer test execution time :jbake-status: published :jbake-order: 10 :jbake-type: page_toc :jbake-menu: arc42 :jbake-title: Quality Requirements Quality Requirements Quality Scenarios Performance Scenarios Scenario Stimulus Response Priority Fast Document Processing Process 1000-line document Complete in &lt; 1 second High Multiple File Processing Process 100 documents Complete in &lt; 10 seconds Medium Memory Usage Process large document (10MB) Use &lt; 100MB RAM High Startup Time Launch linter Ready in &lt; 0.5 seconds Medium Reliability Scenarios Scenario Stimulus Response Priority Error Recovery Invalid input file Clear error message, continue with next file High Configuration Error Invalid rule configuration Detailed error message, use defaults High Plugin Failure Plugin crashes Isolate failure, continue with other rules Medium Resource Exhaustion System low on memory Graceful shutdown, save progress Medium Usability Scenarios Scenario Stimulus Response Priority Clear Error Messages Rule violation found Show file, line, and actionable message High Configuration Change rule settings Take effect without restart Medium Integration Use in CI pipeline Exit code reflects success/failure High Documentation Look up rule details Find explanation within 30 seconds Medium Quality Tree Technical Risks and Technical Debt Risk Analysis Risk Description Impact Probability Mitigation Performance Degradation Rule processing becomes slow with many rules High Medium * Profile rule execution * Implement rule caching * Optimize core algorithms Memory Leaks Long-running processes accumulate memory High Low * Regular memory profiling * Automated testing * Resource cleanup False Positives Rules report incorrect violations Medium High * Extensive test cases * User feedback system * Rule configuration options Plugin Conflicts Custom rules interfere with core rules Medium Medium * Plugin isolation * Version compatibility checks * Clear plugin API Technical Debt Current Technical Debt Area Description Impact Priority Test Coverage Some edge cases not covered Medium High Documentation Some advanced features poorly documented Medium Medium Error Handling Some error cases not specifically handled High High Configuration Hard-coded values that should be configurable Low Low Planned Improvements Risk Matrix Glossary Term Definition Additional Information AsciiDoc Lightweight markup language for documentation Similar to Markdown, but with more features for technical documentation Linter Tool that analyzes source code or text for potential errors Focuses on style, format, and structure issues Rule Individual check that validates specific aspects Can be enabled/disabled and configured Finding Result of a rule check indicating a potential issue Contains message, severity, and location information Severity Importance level of a finding ERROR, WARNING, or INFO Position Location in a document where an issue was found Contains line and optional column information Plugin Extension that adds additional functionality Can provide custom rules and configurations CI/CD Continuous Integration/Continuous Deployment Automated build, test, and deployment process PyPI Python Package Index Central repository for Python packages Virtual Environment Isolated Python runtime environment Manages project-specific dependencies Type Hints Python type annotations Helps with code understanding and static analysis Unit Test Test of individual components Ensures correct behavior of specific functions Integration Test Test of component interactions Verifies system behavior as a whole Coverage Measure of code tested by automated tests Usually expressed as percentage Technical Debt Development shortcuts that need future attention Balance between quick delivery and maintainability "
+    "title": "Glossary",
+    "text": " Table of Contents Glossary Glossary Term Definition Additional Information AsciiDoc Lightweight markup language for documentation Similar to Markdown, but with more features for technical documentation Linter Tool that analyzes source code or text for potential errors Focuses on style, format, and structure issues Rule Individual check that validates specific aspects Can be enabled/disabled and configured Finding Result of a rule check indicating a potential issue Contains message, severity, and location information Severity Importance level of a finding ERROR, WARNING, or INFO Position Location in a document where an issue was found Contains line and optional column information Plugin Extension that adds additional functionality Can provide custom rules and configurations CI/CD Continuous Integration/Continuous Deployment Automated build, test, and deployment process PyPI Python Package Index Central repository for Python packages Virtual Environment Isolated Python runtime environment Manages project-specific dependencies Type Hints Python type annotations Helps with code understanding and static analysis Unit Test Test of individual components Ensures correct behavior of specific functions Integration Test Test of component interactions Verifies system behavior as a whole Coverage Measure of code tested by automated tests Usually expressed as percentage Technical Debt Development shortcuts that need future attention Balance between quick delivery and maintainability "
 },
 
 {
-    "id": 7,
+    "id": 9,
     "uri": "arc42/04_solution_strategy.html",
     "menu": "arc42",
     "title": "Solution Strategy",
@@ -65,7 +81,7 @@ var documents = [
 },
 
 {
-    "id": 8,
+    "id": 10,
     "uri": "arc42/03_system_scope_and_context.html",
     "menu": "arc42",
     "title": "System Scope and Context",
@@ -73,15 +89,7 @@ var documents = [
 },
 
 {
-    "id": 9,
-    "uri": "arc42/12_glossary.html",
-    "menu": "arc42",
-    "title": "Glossary",
-    "text": " Table of Contents Glossary Glossary Term Definition Additional Information AsciiDoc Lightweight markup language for documentation Similar to Markdown, but with more features for technical documentation Linter Tool that analyzes source code or text for potential errors Focuses on style, format, and structure issues Rule Individual check that validates specific aspects Can be enabled/disabled and configured Finding Result of a rule check indicating a potential issue Contains message, severity, and location information Severity Importance level of a finding ERROR, WARNING, or INFO Position Location in a document where an issue was found Contains line and optional column information Plugin Extension that adds additional functionality Can provide custom rules and configurations CI/CD Continuous Integration/Continuous Deployment Automated build, test, and deployment process PyPI Python Package Index Central repository for Python packages Virtual Environment Isolated Python runtime environment Manages project-specific dependencies Type Hints Python type annotations Helps with code understanding and static analysis Unit Test Test of individual components Ensures correct behavior of specific functions Integration Test Test of component interactions Verifies system behavior as a whole Coverage Measure of code tested by automated tests Usually expressed as percentage Technical Debt Development shortcuts that need future attention Balance between quick delivery and maintainability "
-},
-
-{
-    "id": 10,
+    "id": 11,
     "uri": "arc42/09_architecture_decisions.html",
     "menu": "arc42",
     "title": "Architecture Decisions",
@@ -89,7 +97,7 @@ var documents = [
 },
 
 {
-    "id": 11,
+    "id": 12,
     "uri": "arc42/02_architecture_constraints.html",
     "menu": "arc42",
     "title": "Architecture Constraints",
@@ -97,7 +105,7 @@ var documents = [
 },
 
 {
-    "id": 12,
+    "id": 13,
     "uri": "arc42/06_runtime_view.html",
     "menu": "arc42",
     "title": "Runtime View",
@@ -105,7 +113,7 @@ var documents = [
 },
 
 {
-    "id": 13,
+    "id": 14,
     "uri": "canvas/architecture-canvas.html",
     "menu": "canvas",
     "title": "Architecture Communication Canvas: AsciiDoc Linter",
@@ -113,7 +121,7 @@ var documents = [
 },
 
 {
-    "id": 14,
+    "id": 15,
     "uri": "manual/testing.html",
     "menu": "manual",
     "title": "Testing Guide",
@@ -121,7 +129,7 @@ var documents = [
 },
 
 {
-    "id": 15,
+    "id": 16,
     "uri": "manual/development.html",
     "menu": "manual",
     "title": "Development Guide",
@@ -129,7 +137,7 @@ var documents = [
 },
 
 {
-    "id": 16,
+    "id": 17,
     "uri": "manual/usage.html",
     "menu": "manual",
     "title": "Usage Guide",
@@ -137,7 +145,7 @@ var documents = [
 },
 
 {
-    "id": 17,
+    "id": 18,
     "uri": "manual/introduction.html",
     "menu": "manual",
     "title": "Introduction",
@@ -145,7 +153,7 @@ var documents = [
 },
 
 {
-    "id": 18,
+    "id": 19,
     "uri": "manual/index.html",
     "menu": "manual",
     "title": "AsciiDoc Linter Manual",
@@ -153,7 +161,7 @@ var documents = [
 },
 
 {
-    "id": 19,
+    "id": 20,
     "uri": "manual/rules.html",
     "menu": "manual",
     "title": "Rule Reference",
@@ -161,7 +169,7 @@ var documents = [
 },
 
 {
-    "id": 20,
+    "id": 21,
     "uri": "search.html",
     "menu": "-",
     "title": "search",
@@ -169,7 +177,7 @@ var documents = [
 },
 
 {
-    "id": 21,
+    "id": 22,
     "uri": "lunrjsindex.html",
     "menu": "-",
     "title": "null",
diff --git a/manual/development.html b/manual/development.html
index 32a4df0..d4348e3 100644
--- a/manual/development.html
+++ b/manual/development.html
@@ -216,6 +216,10 @@
                 <a class="nav-link " href="../arc42/index.html"><span>arc42</span></a>
             </li>
 
+            <li class="nav-item mr-4 mb-2 mb-lg-0">
+                <a class="nav-link " href="../readme/README.html"><span>readme</span></a>
+            </li>
+
             <li class="nav-item mr-4 mb-2 mb-lg-0">
                 <a class="nav-link " href="../canvas/architecture-canvas.html"><span>canvas</span></a>
             </li>
diff --git a/manual/index.html b/manual/index.html
index f04c186..2a79a96 100644
--- a/manual/index.html
+++ b/manual/index.html
@@ -216,6 +216,10 @@
                 <a class="nav-link " href="../arc42/index.html"><span>arc42</span></a>
             </li>
 
+            <li class="nav-item mr-4 mb-2 mb-lg-0">
+                <a class="nav-link " href="../readme/README.html"><span>readme</span></a>
+            </li>
+
             <li class="nav-item mr-4 mb-2 mb-lg-0">
                 <a class="nav-link " href="../canvas/architecture-canvas.html"><span>canvas</span></a>
             </li>
diff --git a/manual/introduction.html b/manual/introduction.html
index 953bae6..1e6a7c0 100644
--- a/manual/introduction.html
+++ b/manual/introduction.html
@@ -216,6 +216,10 @@
                 <a class="nav-link " href="../arc42/index.html"><span>arc42</span></a>
             </li>
 
+            <li class="nav-item mr-4 mb-2 mb-lg-0">
+                <a class="nav-link " href="../readme/README.html"><span>readme</span></a>
+            </li>
+
             <li class="nav-item mr-4 mb-2 mb-lg-0">
                 <a class="nav-link " href="../canvas/architecture-canvas.html"><span>canvas</span></a>
             </li>
diff --git a/manual/rules.html b/manual/rules.html
index e36512b..901afc3 100644
--- a/manual/rules.html
+++ b/manual/rules.html
@@ -216,6 +216,10 @@
                 <a class="nav-link " href="../arc42/index.html"><span>arc42</span></a>
             </li>
 
+            <li class="nav-item mr-4 mb-2 mb-lg-0">
+                <a class="nav-link " href="../readme/README.html"><span>readme</span></a>
+            </li>
+
             <li class="nav-item mr-4 mb-2 mb-lg-0">
                 <a class="nav-link " href="../canvas/architecture-canvas.html"><span>canvas</span></a>
             </li>
diff --git a/manual/testing.html b/manual/testing.html
index 3520f5c..1b8d371 100644
--- a/manual/testing.html
+++ b/manual/testing.html
@@ -216,6 +216,10 @@
                 <a class="nav-link " href="../arc42/index.html"><span>arc42</span></a>
             </li>
 
+            <li class="nav-item mr-4 mb-2 mb-lg-0">
+                <a class="nav-link " href="../readme/README.html"><span>readme</span></a>
+            </li>
+
             <li class="nav-item mr-4 mb-2 mb-lg-0">
                 <a class="nav-link " href="../canvas/architecture-canvas.html"><span>canvas</span></a>
             </li>
diff --git a/manual/usage.html b/manual/usage.html
index 7f154c4..9dbdb65 100644
--- a/manual/usage.html
+++ b/manual/usage.html
@@ -216,6 +216,10 @@
                 <a class="nav-link " href="../arc42/index.html"><span>arc42</span></a>
             </li>
 
+            <li class="nav-item mr-4 mb-2 mb-lg-0">
+                <a class="nav-link " href="../readme/README.html"><span>readme</span></a>
+            </li>
+
             <li class="nav-item mr-4 mb-2 mb-lg-0">
                 <a class="nav-link " href="../canvas/architecture-canvas.html"><span>canvas</span></a>
             </li>
diff --git a/readme/README.html b/readme/README.html
new file mode 100644
index 0000000..7ae302d
--- /dev/null
+++ b/readme/README.html
@@ -0,0 +1,503 @@
+<!doctype html>
+<html lang="de">
+<head>
+    
+    <!-- sourceuri: readme/README.html -->
+    <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+
+    <meta content="width=device-width, initial-scale=1, shrink-to-fit=no" name="viewport">
+    <meta content="jbake" name="generator">
+    <meta content="INDEX, FOLLOW" name="ROBOTS">
+
+    <title>README.adoc</title>
+    <meta content="docToolchain" property="og:title">
+    <meta content="build your dev docs the easy way..." property="og:description">
+    <meta content="website" property="og:type">
+    <meta content="docToolchain" property="og:site_name">
+    <meta content="docToolchain" itemprop="name">
+    <meta content="build your dev docs the easy way..." itemprop="description">
+    <meta content="summary" name="twitter:card">
+    <meta content="docToolchain" name="twitter:title">
+    <meta content="build your dev docs the easy way..." name="twitter:description">
+
+    <link as="style"
+        href="../css/main.min.881fe5f7b53609f55ebfb496c7097c3b30b2e8ceb20a54bc6a48350ded67224f.css"
+        rel="preload">
+    <link href="../css/main.min.881fe5f7b53609f55ebfb496c7097c3b30b2e8ceb20a54bc6a48350ded67224f.css"
+        integrity=""
+        rel="stylesheet">
+    <link href="../css/asciidoctor.css" rel="stylesheet">
+    <link href="../css/prettify.css" rel="stylesheet">
+
+    <!-- favicon generated with https://www.favicon-generator.org/ -->
+    <link rel="shortcut icon" href="../favicon.ico">
+    <link rel="apple-touch-icon" sizes="57x57" href="../apple-icon-57x57.png">
+    <link rel="apple-touch-icon" sizes="60x60" href="../apple-icon-60x60.png">
+    <link rel="apple-touch-icon" sizes="72x72" href="../apple-icon-72x72.png">
+    <link rel="apple-touch-icon" sizes="76x76" href="../apple-icon-76x76.png">
+    <link rel="apple-touch-icon" sizes="114x114" href="../apple-icon-114x114.png">
+    <link rel="apple-touch-icon" sizes="120x120" href="../apple-icon-120x120.png">
+    <link rel="apple-touch-icon" sizes="144x144" href="../apple-icon-144x144.png">
+    <link rel="apple-touch-icon" sizes="152x152" href="../apple-icon-152x152.png">
+    <link rel="apple-touch-icon" sizes="180x180" href="../apple-icon-180x180.png">
+    <link rel="icon" type="image/png" sizes="192x192" href="../android-icon-192x192.png">
+    <link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png">
+    <link rel="icon" type="image/png" sizes="96x96" href="../favicon-96x96.png">
+    <link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png">
+    <link rel="manifest" href="../manifest.json">
+    <meta name="msapplication-TileColor" content="#ffffff">
+    <meta name="msapplication-TileImage" content="../ms-icon-144x144.png">
+    <meta name="theme-color" content="#ffffff">
+
+    <script src="../js/jquery-3.5.1.min.js"></script>
+    <style>
+    div.bg-light {
+        background-color: rgba(127, 180, 224, 0.3) !important;
+    }
+
+    /* for blog posts */
+    span.blogtag {
+        border-radius: 10px;
+        background-color: #30638E;
+        color: white;
+        padding: 5px 10px;
+    }
+
+    span.blogblogtag a {
+        color: white;
+        padding: 0
+    }
+
+    span.blogtag span {
+        margin-left: 10px;
+        border-radius: 10px;
+        background-color: white;
+        color: #30638E;
+    }
+
+    div.td-toc {
+        height: calc(100vh - 5rem) !important;
+    }
+
+    div#toctitle {
+        display: none
+    }
+
+    #td-section-nav {
+        max-height: calc(100vh - 4rem);
+        font-size: smaller;
+        line-height: 1.1;
+    }
+
+    .td-page-meta {
+        font-size: smaller;
+        line-height: 1.1;
+    }
+
+    #td-section-nav ul.td-sidebar-nav__section {
+        padding-left: 0;
+    }
+
+    span.navbar-logo {
+        padding-right: 1.5em;
+    }
+
+    .match {
+        font-size: smaller;
+    }
+
+    .admonitionblock td.icon .fa:before {
+        font-size: xxx-large;
+    }
+    </style>
+
+    <style>
+    div.openblock.primary div.content, div.openblock.secondary div.content {
+        border: 1px solid #7a2518;
+        padding: 5px;
+    }
+
+    div.openblock.primary div.content div.content, div.openblock.secondary div.content div.content {
+        border: 0 solid #7a2518;
+        padding: 0;
+    }
+
+    .hidden {
+        display: none;
+    }
+
+    .switch {
+        border-width: 1px 1px 0 1px;
+        border-style: solid;
+        border-color: #7a2518;
+        display: inline-block;
+    }
+
+    .switch--item {
+        padding: 2px 10px;
+        background-color: #ffffff;
+        color: #7a2518;
+        display: inline-block;
+        cursor: pointer;
+    }
+
+    .switch--item:not(:first-child) {
+        border-width: 0 0 0 1px;
+        border-style: solid;
+        border-color: #7a2518;
+    }
+
+    .switch--item.selected {
+        background-color: #7a2519;
+        color: #ffffff;
+    }
+    </style>
+
+    <!-- copy-n-paste.js -->
+    <style>
+        div.listingblock {
+            position: relative;
+        }
+        div.listingblock > span.icon {
+            position: absolute;
+            top: 2px;
+            right: 6px;
+            visibility: hidden;
+            z-index: 2;
+            cursor: pointer;
+        }
+        div.listingblock:hover > span.icon {
+            visibility: visible;
+        }
+        div.listingblock div.content pre {
+            margin: 0;
+        }
+    </style>
+    <style>
+        .td-sidebar-nav__section {
+            padding-left: 9px;
+        }
+        details {
+            margin-left: 10px;
+        }
+        summary {
+            cursor: pointer;
+            padding-left: 10px; /* Erhöhter linker Padding für den Pfeil */
+            list-style: none;
+            position: relative; /* Für absolute Positionierung des Pfeils */
+        }
+        summary::before {
+            content: '>';
+            position: absolute;
+            left: 10px; /* Position des Pfeils */
+            top: 50%;
+            transform: translateY(-50%) translateX(-120%);
+            transition: transform 0.3s;
+        }
+        details[open] > summary::before {
+            transform: translateY(-50%) translateX(-120%) rotate(90deg);
+        }
+    </style>
+</head>
+
+<body onload="prettyPrint()" class="td-section">
+<header>
+	
+<nav class="js-navbar-scroll navbar navbar-expand navbar-dark flex-column flex-md-row td-navbar">
+    <a class="navbar-brand" href="../index.html">
+        <span class="navbar-logo"><img src="../images/doctoolchain-logo-blue.png" alt="docToolchain" width="32px" /></span><span
+            class="font-weight-bold">docToolchain</span>
+    </a>
+    <div class="td-navbar-nav-scroll ml-md-auto" id="main_navbar">
+        <ul class="navbar-nav mt-2 mt-lg-0">
+    <li class="nav-item mr-4 mb-2 mb-lg-0"><!--img src="../images/status.png" alt="status" width="16" height="16" onerror="this.style.display='none'"--></li>
+
+            <li class="nav-item mr-4 mb-2 mb-lg-0">
+                <a class="nav-link " href="../arc42/index.html"><span>arc42</span></a>
+            </li>
+
+            <li class="nav-item mr-4 mb-2 mb-lg-0">
+                <a class="nav-link active" href="../readme/README.html"><span>readme</span></a>
+            </li>
+
+            <li class="nav-item mr-4 mb-2 mb-lg-0">
+                <a class="nav-link " href="../canvas/architecture-canvas.html"><span>canvas</span></a>
+            </li>
+
+            <li class="nav-item mr-4 mb-2 mb-lg-0">
+                <a class="nav-link " href="../manual/index.html"><span>manual</span></a>
+            </li>
+
+        </ul>
+    </div>
+    <div class="navbar-nav d-none d-lg-block" >
+        <form action="../search.html">
+        <input aria-label="Search this site…" autocomplete="off" class="form-control td-search-input"
+               placeholder=" Search this site…" type="search" name="q">
+        </form>
+    </div>
+</nav>
+
+</header>
+<div class="container-fluid td-outer">
+	<div class="td-main">
+		<div class="row flex-xl-nowrap">
+			<div class="col-12 col-md-3 col-xl-2 td-sidebar d-print-none">
+				<div class="td-sidebar__inner" id="td-sidebar-menu" >
+					
+
+        <form class="td-sidebar__search d-flex align-items-center d-lg-none" action="../search.html">
+
+            <input aria-label="Search this site…" name="q" autocomplete="off" class="form-control td-search-input"
+                   placeholder=" Search this site…" type="search">
+
+
+            <button aria-controls="td-docs-nav" aria-expanded="false"
+                    aria-label="Toggle section navigation" class="btn btn-link td-sidebar__toggle d-md-none p-0 ml-3 fas fa-bars" data-target="#td-section-nav"
+                    data-toggle="collapse" type="button">
+            </button>
+        </form>
+
+        <nav aria-label="Submenu" class="collapse td-sidebar-nav" id="td-section-nav" >
+
+            <ul class="td-sidebar-nav__section">
+                <li class="td-sidebar-nav__section-title">
+                    <span class="align-left pl-0 pr-2 pt-2 active td-sidebar-link td-sidebar-link__section">readme</span>
+                </li>
+                <li>
+                  <ul>
+                      <li class="collapse show" id="docs">
+                          
+                        <ul class="td-sidebar-nav__section ul-0">
+                            <li class="td-sidebar-nav__section-title td-sidebar-nav__section without-child">
+                                <a class="align-left pl-0 pr-2 pt-2 td-sidebar-link td-sidebar-link__section active"
+                                   href="../readme/README.html" title="README.adoc">README.adoc</a>
+                                
+                            </li>
+                        </ul>
+                      </li>
+                  </ul>
+                <li>
+        </nav>
+
+				</div>
+			</div>
+			<div class="d-none d-xl-block col-xl-2 td-toc d-print-none">
+				<div class="td-page-meta ml-2 pb-1 pt-2 mb-0">
+					
+
+        <a href="##git-repo-url##/readme/README.adoc"
+           target="_blank"><i class="fa fa-edit fa-fw"></i> Improve this doc</a>
+
+
+        <a href="##issue-url##?title=Docs%3A+Feedback+for+%27README.adoc%27&body=%0A%0A%5BEnter%20feedback%20here%5D%0A%0A%0A---%0A%23page:%20##git-repo-url##/readme/README.adoc%0A%23branch:%20main" target="_blank"><i
+                class="fab fa-github fa-fw"></i> Create an issue</a>
+
+        
+
+        <hr />
+
+        
+
+
+
+				</div>
+			</div>
+			<main class="col-12 col-md-9 col-xl-8 pl-md-5" role="main">
+				    <nav aria-label="breadcrumb" class="d-none d-md-block d-print-none">
+        <ol class="breadcrumb spb-1">
+            <!--li aria-current="page" class="breadcrumb-item active">
+                <a href="https://example.docsy.dev/docs/">Documentation</a>
+            </li-->
+
+        </ol>
+    </nav>
+
+
+    <div class="td-content">
+        <p>
+            
+<div class="paragraph">
+<p>Unresolved directive in &lt;stdin&gt; - include::../../README.adoc[]</p>
+</div>
+        </p>
+
+        <style>
+.feedback--answer {
+    display: inline-block;
+}
+
+.feedback--answer-no {
+    margin-left: 1em;
+}
+
+.feedback--response {
+    display: none;
+    margin-top: 1em;
+}
+
+.feedback--response__visible {
+    display: block;
+}
+</style>
+
+<div class="d-print-none">
+    <h2 class="feedback--title">Feedback</h2>
+    <p class="feedback--question">Was this page helpful?</p>
+    <button class="feedback--answer feedback--answer-yes">Yes</button>
+    <button class="feedback--answer feedback--answer-no">No</button>
+    <p class="feedback--response feedback--response-yes">
+        Glad to hear it! Please <a href="##issue-url##?title=Docs%3A+Feedback+for+%27README.adoc%27%20%F0%9F%91%8D&body=%0A%0A%5BEnter%20feedback%20here%5D%0A%0A%0A---%0A%23page:readme/README.adoc">tell us
+    how we can improve</a>.
+    </p>
+    <p class="feedback--response feedback--response-no">
+        Sorry to hear that. Please <a href="##issue-url##?title=Docs%3A+Feedback+for+%27README.adoc%27%20%F0%9F%91%8E&body=%0A%0A%5BEnter%20feedback%20here%5D%0A%0A%0A---%0A%23page:readme/README.adoc">tell
+    us how we can improve</a>.
+    </p>
+</div>
+<script>
+    const yesButton = document.querySelector('.feedback--answer-yes');
+    const noButton = document.querySelector('.feedback--answer-no');
+    const yesResponse = document.querySelector('.feedback--response-yes');
+    const noResponse = document.querySelector('.feedback--response-no');
+    const disableButtons = () => {
+        yesButton.disabled = true;
+        noButton.disabled = true;
+    };
+    const sendFeedback = (value) => {
+        if (typeof ga !== 'function') return;
+        const args = {
+            command: 'send',
+            hitType: 'event',
+            category: 'Helpful',
+            action: 'click',
+            label: window.location.pathname,
+            value: value
+        };
+        ga(args.command, args.hitType, args.category, args.action, args.label, args.value);
+    };
+    yesButton.addEventListener('click', () => {
+        yesResponse.classList.add('feedback--response__visible');
+        disableButtons();
+        sendFeedback(1);
+    });
+    noButton.addEventListener('click', () => {
+        noResponse.classList.add('feedback--response__visible');
+        disableButtons();
+        sendFeedback(0);
+    });
+</script>
+
+
+        <br>
+
+        <!--div class="text-muted mt-5 pt-3 border-top">Last modified July 3, 2019: <a
+                href="https://github.com/google/docsy-example/commit/d6aa89c8b24089d7e6741030864eff209465e896">Added
+            links to user guide repo (d6aa89c)</a>
+        </div-->
+    </div>
+
+
+			</main>
+
+		</div>
+	</div>
+
+
+	
+    <!--footer class="footer mt-auto py-3 bg-light">
+        <div class="container">
+            <span class="text-muted">&copy; 2020 | based on <a href="https://arc42.org">arc42 7.0</a> | mixed with <a href="http://getbootstrap.com/">Bootstrap v5.0.0-beta</a> | Baked with <a href="http://jbake.org">JBake v2.6.7</a></span>
+        </div>
+    </footer-->
+
+    <footer class="bg-dark py-5 row d-print-none">
+        <div class="container-fluid mx-sm-5">
+            <div class="row">
+                <div class="col-6 col-sm-4 text-xs-center order-sm-2">
+
+
+                    <ul class="list-inline mb-0">
+                        
+                        <li aria-label="User mailing list" class="list-inline-item mx-2 h3" data-original-title="User mailing list" data-placement="top"
+                            data-toggle="tooltip" title="">
+                            <a class="text-white" href="mailto:##footer-email##" rel="noopener noreferrer"
+                               target="_blank">
+                                <i class="fa fa-envelope"></i>
+                            </a>
+                        </li>
+                        
+                        
+                        <li aria-label="Twitter" class="list-inline-item mx-2 h3" data-original-title="Twitter" data-placement="top"
+                            data-toggle="tooltip" title="">
+                            <a class="text-white" href="##twitter-url##" rel="noopener noreferrer"
+                               target="_blank">
+                                <i class="fab fa-twitter"></i>
+                            </a>
+                        </li>
+                        
+                        
+                        <li aria-label="Stack Overflow" class="list-inline-item mx-2 h3" data-original-title="Stack Overflow" data-placement="top"
+                            data-toggle="tooltip" title="">
+                            <a class="text-white" href="##Stackoverflow-url##" rel="noopener noreferrer"
+                               target="_blank">
+                                <i class="fab fa-stack-overflow"></i>
+                            </a>
+                        </li>
+                        
+                    </ul>
+
+
+                </div>
+                <div class="col-6 col-sm-4 text-right text-xs-center order-sm-3">
+
+
+                    <ul class="list-inline mb-0">
+
+                        
+                        <li aria-label="GitHub" class="list-inline-item mx-2 h3" data-original-title="GitHub" data-placement="top"
+                            data-toggle="tooltip" title="">
+                            <a class="text-white" href="##Github-url##" rel="noopener noreferrer"
+                               target="_blank">
+                                <i class="fab fa-github"></i>
+                            </a>
+                        </li>
+                        
+
+                        
+                        <li aria-label="Slack" class="list-inline-item mx-2 h3" data-original-title="Slack" data-placement="top"
+                            data-toggle="tooltip" title="">
+                            <a class="text-white" href="##Slack-url##" rel="noopener noreferrer"
+                               target="_blank">
+                                <i class="fab fa-slack"></i>
+                            </a>
+                        </li>
+                        
+
+
+                    </ul>
+
+
+                </div>
+                <div class="col-12 col-sm-4 text-center py-2 order-sm-2">
+
+                        <small class="text-white">built with <a href="https://doctoolchain.org">docToolchain</a> and <a href="https://jbake.org">jBake</a> <br /> theme: <a href="https://www.docsy.dev/">docsy</a></small>
+
+                </div>
+            </div>
+        </div>
+    </footer>
+
+    <script src="../js/popper.min.js"></script>
+    <script src="../js/bootstrap.min.js"></script>
+
+
+    <script src="../js/main.min.b5fc1b29d2465835844254bd4d804738eaf24c0cec53009b4c6899989be55a47.js"></script>
+    <script src="../js/blocks.js" ></script>
+    <script src="../js/prettify.js"></script>
+    <script src="../js/copy-n-paste.js"></script>
+    <script src="../js/submenucollapse.js"></script>
+
+
+</body>
+</html>
diff --git a/search.html b/search.html
index 3a15193..6bbaa81 100644
--- a/search.html
+++ b/search.html
@@ -216,6 +216,10 @@
                 <a class="nav-link " href="arc42/index.html"><span>arc42</span></a>
             </li>
 
+            <li class="nav-item mr-4 mb-2 mb-lg-0">
+                <a class="nav-link " href="readme/README.html"><span>readme</span></a>
+            </li>
+
             <li class="nav-item mr-4 mb-2 mb-lg-0">
                 <a class="nav-link " href="canvas/architecture-canvas.html"><span>canvas</span></a>
             </li>
diff --git a/sitemap.xml b/sitemap.xml
index 8c8c143..818f138 100644
--- a/sitemap.xml
+++ b/sitemap.xml
@@ -6,6 +6,11 @@
     	<lastmod>2024-11-27</lastmod>
     </url>
 
+    <url>
+    	<loc>http://jbake.org/readme/README.html</loc>
+    	<lastmod>2024-11-27</lastmod>
+    </url>
+
     <url>
     	<loc>http://jbake.org/arc42/08_concepts.html</loc>
     	<lastmod>2024-11-27</lastmod>
@@ -27,27 +32,27 @@
     </url>
 
     <url>
-    	<loc>http://jbake.org/arc42/10_quality_requirements.html</loc>
+    	<loc>http://jbake.org/arc42/index.html</loc>
     	<lastmod>2024-11-27</lastmod>
     </url>
 
     <url>
-    	<loc>http://jbake.org/arc42/index.html</loc>
+    	<loc>http://jbake.org/arc42/10_quality_requirements.html</loc>
     	<lastmod>2024-11-27</lastmod>
     </url>
 
     <url>
-    	<loc>http://jbake.org/arc42/04_solution_strategy.html</loc>
+    	<loc>http://jbake.org/arc42/12_glossary.html</loc>
     	<lastmod>2024-11-27</lastmod>
     </url>
 
     <url>
-    	<loc>http://jbake.org/arc42/03_system_scope_and_context.html</loc>
+    	<loc>http://jbake.org/arc42/04_solution_strategy.html</loc>
     	<lastmod>2024-11-27</lastmod>
     </url>
 
     <url>
-    	<loc>http://jbake.org/arc42/12_glossary.html</loc>
+    	<loc>http://jbake.org/arc42/03_system_scope_and_context.html</loc>
     	<lastmod>2024-11-27</lastmod>
     </url>