Move sequence diagram into dedicated docs page

cardano-scaling · Jul 10, 2024 · ec8f37d · ec8f37d
1 parent 7d0f1e9
commit ec8f37d
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 41 deletions.
diff --git a/docs/core-concepts/index.md b/docs/core-concepts/index.md
@@ -10,44 +10,3 @@ import {useDocsSidebar} from '@docusaurus/theme-common/internal';
 
 <DocCardList items={useDocsSidebar().items.filter(({ docId }) => docId != "index")}/>
 ```
-
-### Incremental Decommits
-
-```mermaid
-sequenceDiagram
-    Alice->>HeadLogic: Decommit (decTx)
-    HeadLogic->>HeadLogic: canApply decTx
-
-    par broadcast
-        HeadLogic->>HeadLogic: ReqDec decTx
-    and
-        HeadLogic->>Node B: ReqDec decTx
-    end
-
-    HeadLogic -->> Alice: DecommitRequested
-
-    par Alice isLeader
-        HeadLogic->>HeadLogic: ReqSn decTx
-    and
-        HeadLogic->>Node B: ReqSn decTx
-    end
-
-    HeadLogic->>HeadLogic: canApply decTx, decUTxO =  outputs(decTx)
-    HeadLogic->>HeadLogic: sig = sign snapshot incl. decUTxO
-
-    par broadcast
-        HeadLogic->>HeadLogic: AckSn sig
-    and
-        HeadLogic->>Node B: AckSn sig
-    end
-
-    Node B->>HeadLogic: AckSn sig
-
-    HeadLogic -->> Alice: SnapshotConfirmed
-    HeadLogic -->> Alice: DecommitApproved
-
-    HeadLogic ->> Chain: DecrementTx snapshot sig
-    Chain ->> HeadLogic: OnDecrementTx
-    HeadLogic -->> Alice: DecommitFinalized
-```
-
diff --git a/docs/docs/dev/protocol.md b/docs/docs/dev/protocol.md
@@ -0,0 +1,43 @@
+# Protocol
+
+Additional implementation-specific documentation for the Hydra Head protocol and extensions like incremental decommits.
+
+### Incremental Decommits
+
+```mermaid
+sequenceDiagram
+    Alice->>HeadLogic: Decommit (decTx)
+    HeadLogic->>HeadLogic: canApply decTx
+
+    par broadcast
+        HeadLogic->>HeadLogic: ReqDec decTx
+    and
+        HeadLogic->>Node B: ReqDec decTx
+    end
+
+    HeadLogic -->> Alice: DecommitRequested
+
+    par Alice isLeader
+        HeadLogic->>HeadLogic: ReqSn decTx
+    and
+        HeadLogic->>Node B: ReqSn decTx
+    end
+
+    HeadLogic->>HeadLogic: canApply decTx, decUTxO =  outputs(decTx)
+    HeadLogic->>HeadLogic: sig = sign snapshot incl. decUTxO
+
+    par broadcast
+        HeadLogic->>HeadLogic: AckSn sig
+    and
+        HeadLogic->>Node B: AckSn sig
+    end
+
+    Node B->>HeadLogic: AckSn sig
+
+    HeadLogic -->> Alice: SnapshotConfirmed
+    HeadLogic -->> Alice: DecommitApproved
+
+    HeadLogic ->> Chain: DecrementTx snapshot sig
+    Chain ->> HeadLogic: OnDecrementTx
+    HeadLogic -->> Alice: DecommitFinalized
+```
diff --git a/docs/sidebars.js b/docs/sidebars.js
@@ -83,6 +83,7 @@ module.exports = {
       type: "autogenerated",
       dirName: "dev",
     },
+    "dev/protocol",
     {
       type: "link",
       href: "/adr",