set a home index.html

dingste · Apr 12, 2024 · cbf8193 · cbf8193
1 parent fd21705
commit cbf8193
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 39 deletions.
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@ I have the will to create a new programming language.
 _why?_ Cause I can. ;-) seriously, cause I'm a old man knowing so many programming languages and they are all *meh*. I try to make this better, so save your judging and contribute!
 
 ## HOWTO
-Checkout [github-page The mDm Reference](https://dingste.github.io/mDm/introduction/).
+Checkout [github-page The mDm Reference](https://dingste.github.io/mDm/index.html).
 The approach of all is in [The mDm Reference](The_mDm_Reference.md) and grows ... 
 The PDF is generate by mkdocs. Feel free, to `source documentation_pyenv/bin/activate` and `mkdocs build` or `mkdocs serve`
 

diff --git a/docs/core-concepts/dnib.md b/docs/core-concepts/dnib.md
@@ -1,34 +1,9 @@
 In mDm, **dNibs** are fundamental in defining how data is interpreted at any given memory location. A dNib consists of two bits that encode metadata about the data stored in the remaining bits of a memory unit. These two bits determine whether the content at the memory location is a specific type of data or an address, and whether it represents the end of the data or an address.
 
-**PlantUML Diagram for dNib Memory Representation**
-
 Since a visual representation can help in understanding the concept of dNibs, here is a PlantUML diagram illustrating how dNibs are used to interpret memory content:
 
 ```plantuml
-@startuml
-skinparam monochrome true
-
-class Memory {
-  -dNib: Byte
-  -Data: Byte
-}
-
-note right of Memory
-  The 'dNib' controls:
-  - Data or Address (1 bit)
-  - End marker (1 bit)
-end note
-
-Memory -> Memory : Self Reference for Sequential Access
-
-note "Memory Layout" as N1
-  Each byte of memory is divided into:
-  - 2 bits for dNib
-  - Remaining bits for data
-end note
-
-Memory -down-> N1
-@enduml
+
 ```
 
 **Type Safety and Declaration**

diff --git a/docs/diagrams/src/all_diagrams.puml b/docs/diagrams/src/all_diagrams.puml
@@ -267,3 +267,25 @@ note left of Address : Adressindikator zeigt auf\ndie Daten.
 note right of Data : Dateninhalt neben\ndem dNib.
 @enduml
 
+@startuml "dNibs"
+class "Memory" {
+  -dNib: 2 Bits
+  -Data: Byte
+}
+
+note "Memory"
+  The dNib controls:
+  - Data or Address (1 bit)
+  - End marker (1 bit)
+end note
+
+"Memory" -> "Memory" : Self Reference for Sequential Access
+
+note "Memory Layout" 
+  Each byte of memory is divided into:
+  - 2 bits for dNib
+  - Remaining bits for data
+end note
+
+"Memory" -down-> "Memory Layout"
+@enduml
diff --git a/docs/introduction.md → docs/index.md b/docs/introduction.md → docs/index.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -23,16 +23,16 @@ plugins:
   - git-revision-date-localized:
       enable_creation_date: true
   - search
-#  - build_plantuml:
-#      render: 'local'
-#      bin_path: '/usr/bin/plantuml' 
-#      disable_ssl_certificate_validation: true 
-#      output_format: 'svg' # or "png"
-#      allow_multiple_roots: false 
-#      diagram_root: 'docs/diagrams'
-#      output_folder: 'out'
-#      input_folder: 'src'
-#      input_extensions: ''
+  - build_plantuml:
+      render: 'local'
+      bin_path: '/usr/bin/plantuml' 
+      disable_ssl_certificate_validation: true 
+      output_format: 'svg' # or "png"
+      allow_multiple_roots: false 
+      diagram_root: 'docs/diagrams'
+      output_folder: 'docs/diagrams/out'
+      input_folder: 'docs/diagrams/src'
+      input_extensions: ''
   - extra-sass
   - with-pdf:
       author: Dieter Steuten
@@ -47,7 +47,7 @@ plugins:
       verbose: false
 
 nav:
-  - Introduction: introduction.md
+  - Home: index.md
   - Abstract: abstract.md
   - Core Concepts:
       - IPO Model: core-concepts/ipo-model.md
@@ -57,7 +57,6 @@ nav:
       - Implicit is Wack!: advanced-topics/implicit-is-wack.md
   - Advanced Topics:
       - Memory Management: advanced-topics/memory-management.md
-      - Dynamic Memory Management: advanced-topics/dynamic-memory-management.md
       - Support for Complex Data Structures: advanced-topics/support-for-complex-data-structures.md
       - Type & Error System: advanced-topics/type-error-system.md
       - Unsort: advanced-topics/unsort.md