Skip to content

Commit 41e50ff

Browse files
Add additional Mermaid diagrams for enhanced documentation clarity
1 parent f0ae38e commit 41e50ff

1 file changed

Lines changed: 68 additions & 0 deletions

File tree

docs/index.md

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,74 @@ graph LR
1414
B ---->|No| E[Yay!];
1515
```
1616

17+
``` mermaid
18+
sequenceDiagram
19+
autonumber
20+
Alice->>John: Hello John, how are you?
21+
loop Healthcheck
22+
John->>John: Fight against hypochondria
23+
end
24+
Note right of John: Rational thoughts!
25+
John-->>Alice: Great!
26+
John->>Bob: How about you?
27+
Bob-->>John: Jolly good!
28+
```
29+
30+
``` mermaid
31+
stateDiagram-v2
32+
state fork_state <<fork>>
33+
[*] --> fork_state
34+
fork_state --> State2
35+
fork_state --> State3
36+
37+
state join_state <<join>>
38+
State2 --> join_state
39+
State3 --> join_state
40+
join_state --> State4
41+
State4 --> [*]
42+
```
43+
44+
``` mermaid
45+
classDiagram
46+
Person <|-- Student
47+
Person <|-- Professor
48+
Person : +String name
49+
Person : +String phoneNumber
50+
Person : +String emailAddress
51+
Person: +purchaseParkingPass()
52+
Address "1" <-- "0..1" Person:lives at
53+
class Student{
54+
+int studentNumber
55+
+int averageMark
56+
+isEligibleToEnrol()
57+
+getSeminarsTaken()
58+
}
59+
class Professor{
60+
+int salary
61+
}
62+
class Address{
63+
+String street
64+
+String city
65+
+String state
66+
+int postalCode
67+
+String country
68+
-validate()
69+
+outputAsLabel()
70+
}
71+
```
72+
73+
``` mermaid
74+
erDiagram
75+
CUSTOMER ||--o{ ORDER : places
76+
ORDER ||--|{ LINE-ITEM : contains
77+
LINE-ITEM {
78+
string name
79+
int pricePerUnit
80+
}
81+
CUSTOMER }|..|{ DELIVERY-ADDRESS : uses
82+
```
83+
84+
1785
## Supported Platforms
1886

1987
This development framework is built to serve the needs of modern developers and environments. We prioritize supporting the latest Long-Term Servicing

0 commit comments

Comments
 (0)