feat: update yanga internals presentation

Author: cuinixam

docs/presentations/yanga/images/yanga_cli.png

@@ -36,6 +36,7 @@
     <script src="/_static/js/reveal.js/plugin/notes/notes.js"></script>
     <script src="/_static/js/reveal.js/plugin/markdown/markdown.js"></script>
     <script src="/_static/js/reveal.js/plugin/highlight/highlight.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/reveal.js-mermaid-plugin@11.4.1/plugin/mermaid/mermaid.min.js"></script>
     <script>
       // More info about initialization & config:
       // - https://revealjs.com/initialization/
@@ -47,7 +48,7 @@
         pdfMaxPagesPerSlide: 1,
         backgroundTransition: "slide",
         // Learn about plugins: https://revealjs.com/plugins/
-        plugins: [RevealMarkdown, RevealHighlight, RevealNotes],
+        plugins: [RevealMarkdown, RevealHighlight, RevealNotes, RevealMermaid],
         //width: "80%",
         //height: "100%",
       });

docs/presentations/yanga/images/yanga_gui.png

@@ -1,28 +1,13 @@
 ## What is YANGA?
 
-<!-- .slide: data-transition="none" -->
-
---
-
-## What is YANGA?
-
-<!-- .slide: data-transition="none" -->
 
-It is a Python application.
+It is a Python application. <!-- .element: class="fragment" -->
 
 --
 
 ## What is it for?
 
-<!-- .slide: data-transition="none" -->
-
-Note:
-
-Why are we talking about a Line? A Product Line? A Software Product Line?
-
---
-
-## Software Product Line
+Software Product Lines <!-- .element: class="fragment" -->
 
 <!-- .slide: data-transition="none" -->
 
@@ -65,7 +50,7 @@ Terminology <!-- .element: class="monospacesmall" -->
 ```yaml [1-10]
 pipeline:
   - install:
-      - step: RunScoop
+      - step: InstallTools
   - gen:
       - step: FeatureModel
   - build:
@@ -84,7 +69,7 @@ yanga.yaml <!-- .element: class="monospacesmall" -->
 ```yaml [9-10]
 pipeline:
   - install:
-      - step: RunScoop
+      - step: InstallTools
   - gen:
       - step: FeatureModel
   - build:
@@ -103,7 +88,7 @@ yanga.yaml <!-- .element: class="monospacesmall" -->
 ```yaml [8-8]
 pipeline:
   - install:
-      - step: RunScoop
+      - step: InstallTools
   - gen:
       - step: FeatureModel
   - build:
@@ -120,7 +105,7 @@ pipeline:
 ```yaml [1-10]
 pipeline:
   - install:
-      - step: RunScoop
+      - step: InstallTools
   - gen:
       - step: FeatureModel
   - build:
@@ -294,29 +279,263 @@ components:
 
 ---
 
-## **SPL Demo**
+## <img src="images/yanga.png" class="inline-image"> <a href="https://yanga.readthedocs.io">YANGA Internals</a>
 
-<!-- .slide: data-background-color="#4b8e4eff" -->
+--
 
----
+## Architecture
+
+- Domain Layer - Core business logic  <!-- .element: class="fragment" -->
+- Interface Layer - CLI/GUI/Python interface  <!-- .element: class="fragment" -->
+- Backend Layer - Build system generators  <!-- .element: class="fragment" -->
+
+--
+
+## Domain Layer
+
+`src/yanga/domain/` <!-- .element: class="monospacesmall" -->
+
+- ExecutionContext - Shared information <!-- .element: class="fragment" -->
+- ProjectSlurper - Creates the domain model <!-- .element: class="fragment" -->
+- Component - Buildable units with sources & tests <!-- .element: class="fragment" -->
+- VariantConfig - SPL variant definition <!-- .element: class="fragment" -->
+- PlatformConfig - Platform settings <!-- .element: class="fragment" -->
+
+--
+
+## Interface Layer
+
+--
+
+## CLI
+
+<div class="small-container">
+  <img src="images/yanga_cli.png" height="400">
+</div>
+
+--
+
+## GUI
+
+<div class="small-container">
+  <img src="images/yanga_gui.png" height="400">
+</div>
+
+--
+
+## Python
+
+```python
+from pathlib import Path
+from yanga.commands.run import RunCommand, RunCommandConfig
+
+RunCommand().do_run(
+    RunCommandConfig(
+        project_dir=Path.cwd(),
+        platform=platform,
+        variant_name=self.variant_name,
+        not_interactive=True,
+        target="report",
+    )
+)
+
+```
+
+--
+
+## Backend Layer
+
+`src/yanga/cmake/` <!-- .element: class="monospacesmall" -->
+
+```python
+class CMakeGenerator(ABC):
+    @abstractmethod
+    def generate(self) -> list[CMakeElement]:
+        pass
+
+class ExecutableCMakeGenerator(CMakeGenerator):
+    def generate(self) -> list[CMakeElement]:
+        # Generate CMake targets for executables
+```
+
+<!-- .element: class="fragment" -->
+
+--
+
+## Flow Chart
+
+<div class="mermaid">
+<pre>
+flowchart LR
+    %% User Interfaces (Top Level)
+    CLI[🖥️ Command Line]
+    GUI[🖱️ GUI App]
+    API[🐍 Python Code]
+
+    %% All paths lead to the core
+    CLI --> CORE
+    GUI --> CORE
+    API --> CORE
+
+    %% The Heart of Yanga
+    CORE[⚙️ RunCommand]
+
+    %% Simple processing steps
+    CORE --> CHOOSE[🎯 Choose What to Build<br/>variant + platform]
+    CORE --> READ[📖 Read Project Config<br/>YAML files]
+    CHOOSE --> PLAN[📋 Plan Build Steps<br/>create pipeline]
+    READ --> PLAN
+    PLAN --> BUILD[🔨 Execute Pipeline<br/>install, generate, build]
+</pre>
+</div>
+
+--
+
+## Extension Points
+
+- Pipeline Steps <!-- .element: class="fragment" -->
+- CMake Generators <!-- .element: class="fragment" -->
+
+--
+
+## Pipeline Steps
+
+- ScoopInstall* - install tool dependencies <!-- .element: class="fragment" -->
+- WestInstall - download all external components <!-- .element: class="fragment" -->
+- KConfigGen - KConfig code generation step <!-- .element: class="fragment" -->
+- GenerateBuildSystemFiles <!-- .element: class="fragment" -->
+- ExecuteBuild<!-- .element: class="fragment" -->
+
+--
+
+## Extending
+
+New step?
+
+```python
+class DeployArtifacts(PipelineStep[ExecutionContext]):
+    def __init__(
+      self,
+      execution_context: ExecutionContext,
+    ) -> None:
+        pass
+
+    def run(self) -> int:
+        pass
+```
+<!-- .element: class="fragment" -->
+
+--
+
+## Extending
+
+```yaml
+pipeline:
+  - step: DeployArtifacts
+    module: deployment
+    config:
+      server: my_server.com
+```
+
+--
+
+## CMake Generators
+
+- CreateExecutable  <!-- .element: class="fragment" -->
+- GTest  <!-- .element: class="fragment" -->
+- CppCheck  <!-- .element: class="fragment" -->
+- ObjectDeps  <!-- .element: class="fragment" -->
+- TargetsData  <!-- .element: class="fragment" -->
+- Report  <!-- .element: class="fragment" -->
+
+--
+
+## Extending
+
+New cmake generator?
+
+```python
+class CreateHex(CMakeGenerator):
+    def __init__(
+      self,
+      execution_context: ExecutionContext,
+    ) -> None:
+        pass
+
+    def generate(self) -> list[CMakeElement]:
+        pass
+```
+<!-- .element: class="fragment" -->
+
+--
+
+## Reports Generation
 
-## Next steps
+--
+
+## What gets reported?
+
+- 📖 Source Code Documentation (Clanguru) <!-- .element: class="fragment" -->
+- 🔍 Static Analysis (CppCheck) <!-- .element: class="fragment" -->
+- 📊 Coverage (gcovr) <!-- .element: class="fragment" -->
+
+--
+
+## How?
+
+```yaml
+platforms:
+  - name: gtest
+    cmake_generators:
+      - step: CppCheckCMakeGenerator
+      - step: GTestCMakeGenerator
+      # Shall run after all other generators that produce reports
+      - step: ReportCMakeGenerator
+        module: yanga.cmake.reports
+```
 
 --
 
-## Multi-pipeline
+## Extending
+
+New report type?
 
-|       | Build | Run | Release |
-| ----- | ----- | --- | ------- |
-| exe   | ✅    | ✅  |        |
-| gtest | ✅    | ✅  |        |
-| hil   | ✅    | ✅  |        |
-| ecu   | ✅    |     | ✅💰  |
+```python [4-6]
+class MyAnalysisGenerator(CMakeGenerator):
+    def generate(self):
+        # Your custom analysis
+        self.execution_context.data_registry.insert(
+            ReportRelevantFiles(...)
+        )
+```
+<!-- .element: class="fragment" -->
+
+--
+
+## How?
+
+```yaml [6]
+platforms:
+  - name: gtest
+    cmake_generators:
+      - step: CppCheckCMakeGenerator
+      - step: GTestCMakeGenerator
+      - step: MyAnalysisGenerator
+      - step: ReportCMakeGenerator
+```
 
 ---
 
-## <img src="images/yanga.png" class="inline-image"> <a href="https://yanga.readthedocs.io">YANGA</a>
+## **SPL Demo**
+
+<!-- .slide: data-background-color="#4b8e4eff" -->
 
 ---
 
-## ❕Thank you❕
+## Thank you❕
+
+---
+
+## Questions?
+
+<img src="images/yanga.png" class="inline-image"> <a href="https://yanga.readthedocs.io">YANGA</a>