Added two MMD files to generate the first two diagrams

praekeltfoundation · Feb 26, 2024 · a53e13d · a53e13d
1 parent 44fb7bc
commit a53e13d
Show file tree

Hide file tree

Showing 5 changed files with 142 additions and 7 deletions.
diff --git a/contentpage_data_structure.png b/contentpage_data_structure.png
diff --git a/contentrepo_page_structure.png b/contentrepo_page_structure.png
diff --git a/home/docs/mermaid_class.mmd b/home/docs/mermaid_class.mmd
@@ -0,0 +1,130 @@
+classDiagram
+    ContentPage <|-- Web
+    ContentPage <|-- Whatsapp
+    ContentPage <|-- SMS
+    ContentPage <|-- USSD
+    ContentPage <|-- Viber
+    ContentPage <|-- Messenger
+    Web <|-- WebBody
+
+    Whatsapp <|-- WhatsappTemplateCategory
+    Whatsapp <|-- WhatsappBody
+    WhatsappBody <|-- "1 or more" WhatsappMessage
+    WhatsappMessage <|-- "0 or more" VariableExampleValues
+    WhatsappMessage <|-- VariationMessage
+    WhatsappMessage <|-- "3" Buttons
+    WhatsappMessage <|-- ListItems
+    WhatsappMessage <|-- Footer
+
+    VariationMessage <|-- VariationRestriction 
+    VariationRestriction <|-- ProfileValue
+
+    Buttons <|-- GotoPage
+    Buttons <|-- NextMessage
+
+    SMS <|-- "1 or more" SMSBody
+
+    USSD <|-- USSDBody
+
+    Messenger <|-- MessengerBody
+
+    Viber <|-- ViberBody
+
+    class SMS{
+        +String SmsTitle
+        +SMSBody SMSBody
+    } 
+    class SMSBody{
+        String Message
+    }
+    class USSD{
+        +String USSDTitle
+        +USSDBody USSDBody
+    } 
+    class USSDBody{
+        +String Message
+    }
+    class Messenger{
+        +String MessengerTitle
+        +MessengerBody MessengerBody
+    }
+    class MessengerBody{
+        +Image Image
+        +String Message
+    }
+    class Viber{
+        +String ViberTitle
+        ViberBody ViberBody
+    }
+    class ViberBody{
+        +Image Image
+        +String Message
+    }  
+    class Web{
+        +String Title
+        +String Subtitle
+        +WebBody WebBody
+        +IncludeInFooter()
+    }
+    class WebBody{
+        +String Paragraph
+        +Image Image
+    }
+    class VariationMessage{
+
+    }
+    class VariationRestriction{
+        ProfileValue ProfileValue
+    }
+    class ListItems{
+        +String Title
+    }
+    class ProfileValue{
+        Gender Gender
+        Age Age
+        Relationship Relationship
+
+    }
+    class Buttons{
+        NextMessage NextMessage
+        GotoPage GotoPage
+
+    }
+    class GotoPage{
+        String Title
+        Page Page
+    }
+    class NextMessage{
+        String Title
+    }
+    class WhatsappMessage{
+        +String Message
+        +Image Image
+        +Document Document
+        +Media Media
+        +VariableExampleValues ExampleValues
+        +VariationMessage VariationMessage
+        +String NextPrompt
+        +Buttons Buttons
+        +ListItems ListItems
+        +Footer Footer
+
+    }
+    class Footer{
+        String Footer    
+    }
+    class VariableExampleValues{
+        +String ExampleValue
+    }
+    class WhatsappBody{
+        +WhatsappMessage WhatsappMessage
+
+    }
+    class WhatsappTemplateCategory{
+        +String CategoryName
+    }
+    class Whatsapp{
+        +String WhatsappTitle
+        +WhatsappTemplateCategory TemplateCategory
+        +IsTemplate()
+    }
diff --git a/home/docs/mermaid_structure.mmd b/home/docs/mermaid_structure.mmd
@@ -0,0 +1,12 @@
+  graph TD;
+      Pages --> Homepage
+      Homepage -->ContentPageIndex;
+      ContentPageIndex -->ContentPage;
+      ContentPage -->Web;
+      ContentPage -->WhatsApp;
+      ContentPage -->SMS;
+      ContentPage -->USSD;
+      ContentPage -->Viber;
+      ContentPage --> Messenger
+
+
diff --git a/home/mermaid_test.md b/home/mermaid_test.md