From eaa22373b4b70fded612e86ad8f68174dd1aeb8e Mon Sep 17 00:00:00 2001 From: Mark Fulton Date: Thu, 13 Jun 2024 12:57:00 -0500 Subject: [PATCH] docs: mermaid diagrams - Replaces `.puml` files with `.md` files - Uses Mermaid for diagrams (supported by GitHub Flavored Markdown) --- docs/Session.md | 19 +++++++++++++++++++ docs/Signaling.md | 24 ++++++++++++++++++++++++ uml/Session.puml | 19 ------------------- uml/Signaling.puml | 23 ----------------------- 4 files changed, 43 insertions(+), 42 deletions(-) create mode 100644 docs/Session.md create mode 100644 docs/Signaling.md delete mode 100644 uml/Session.puml delete mode 100644 uml/Signaling.puml diff --git a/docs/Session.md b/docs/Session.md new file mode 100644 index 0000000..7ca46c9 --- /dev/null +++ b/docs/Session.md @@ -0,0 +1,19 @@ +# Session State Diagram + +```mermaid +stateDiagram-v2 + [*] --> GrabLocalMedia + GrabLocalMedia --> CreateOffer + GrabLocalMedia --> Failed + CreateOffer --> SetLocalSessionDescription + CreateOffer --> Failed + SetLocalSessionDescription --> CollectSignalingAndIceCollection + SetLocalSessionDescription --> Failed + CollectSignalingAndIceCollection --> InviteAnswer + CollectSignalingAndIceCollection --> Failed + InviteAnswer --> Accept + InviteAnswer --> Failed + Accept --> Talking + Accept --> Failed + Talking --> Disconnected +``` diff --git a/docs/Signaling.md b/docs/Signaling.md new file mode 100644 index 0000000..bc8c208 --- /dev/null +++ b/docs/Signaling.md @@ -0,0 +1,24 @@ +# Signaling State Diagram + +```mermaid +stateDiagram-v2 + [*] --> PendingConnection + PendingConnection --> PendingInvite + PendingConnection --> PendingConnection : RETRY + PendingConnection --> Failed + PendingInvite --> PendingAnswer + PendingInvite --> Failed + PendingAnswer --> PendingAccept + PendingAnswer --> Failed + PendingAccept --> PendingAcceptAck + PendingAccept --> Failed + PendingAcceptAck --> Talking + PendingAcceptAck --> Failed + Talking --> PendingRemoteHangup + Talking --> PendingLocalHangup + Talking --> PendingReconnect + PendingReconnect --> Talking + PendingReconnect --> Failed + PendingRemoteHangup --> Disconnected + PendingLocalHangup --> Disconnected +``` \ No newline at end of file diff --git a/uml/Session.puml b/uml/Session.puml deleted file mode 100644 index ebfe913..0000000 --- a/uml/Session.puml +++ /dev/null @@ -1,19 +0,0 @@ -@startuml - -[*] --> GrabLocalMedia -GrabLocalMedia --> CreateOffer -GrabLocalMedia --> Failed -CreateOffer --> SetLocalSessionDescription -CreateOffer --> Failed -SetLocalSessionDescription --> CollectSignalingAndIceCollection -SetLocalSessionDescription --> Failed -CollectSignalingAndIceCollection --> InviteAnswer -CollectSignalingAndIceCollection --> Failed -InviteAnswer --> Accept -InviteAnswer --> Failed -Accept --> Talking -Accept --> Failed -Talking --> Disconnected - -@enduml - diff --git a/uml/Signaling.puml b/uml/Signaling.puml deleted file mode 100644 index 618fa57..0000000 --- a/uml/Signaling.puml +++ /dev/null @@ -1,23 +0,0 @@ -@startuml - -[*] --> PendingConnection -PendingConnection --> PendingInvite -PendingConnection --> PendingConnection : RETRY -PendingConnection --> Failed -PendingInvite --> PendingAnswer -PendingInvite --> Failed -PendingAnswer --> PendingAccept -PendingAnswer --> Failed -PendingAccept --> PendingAcceptAck -PendingAccept --> Failed -PendingAcceptAck --> Talking -PendingAcceptAck --> Failed -Talking --> PendingRemoteHangup -Talking --> PendingLocalHangup -Talking --> PendingReconnect -PendingReconnect --> Talking -PendingReconnect --> Failed -PendingRemoteHangup --> Disconnected -PendingLocalHangup --> Disconnected - -@enduml