From 83102a27268b75cd205e2dbb2e4e46be48f4b3b3 Mon Sep 17 00:00:00 2001
From: x <x@x>
Date: Sun, 23 Oct 2022 10:49:47 +0000
Subject: [PATCH] add mermaid to mdbook + gantt chart for project release cycle

---
 .github/workflows/book.yml           |  1 +
 doc/README.md                        |  1 +
 doc/book.toml                        |  4 ++++
 doc/src/architecture/architecture.md | 14 ++++++++++++++
 4 files changed, 20 insertions(+)

diff --git a/.github/workflows/book.yml b/.github/workflows/book.yml
index ad50c8493..a3bdbdaaf 100644
--- a/.github/workflows/book.yml
+++ b/.github/workflows/book.yml
@@ -35,6 +35,7 @@ jobs:
                 export PATH="$HOME/.cargo/bin:$PATH"
                 cargo install --git "https://github.com/lzanini/mdbook-katex"
                 cargo install --git "https://github.com/badboy/mdbook-toc"
+                cargo install --git "https://github.com/badboy/mdbook-mermaid"
                 sudo apt -y install make
 
             - name: Compile and publish the book
diff --git a/doc/README.md b/doc/README.md
index 268be62c1..23b669d57 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -12,4 +12,5 @@ For the mdbook-katex backend run:
 ```
 cargo install --git "https://github.com/lzanini/mdbook-katex"
 cargo install --git "https://github.com/badboy/mdbook-toc"
+cargo install --git "https://github.com/badboy/mdbook-mermaid"
 ```
diff --git a/doc/book.toml b/doc/book.toml
index a0a23dd88..57c852df7 100644
--- a/doc/book.toml
+++ b/doc/book.toml
@@ -10,6 +10,7 @@ copy-fonts = true
 default-theme = "ayu"
 preferred-dark-theme = "ayu"
 theme = "theme"
+additional-js = ["mermaid.min.js", "mermaid-init.js"]
 
 [output.html.playground]
 runnable = false
@@ -22,3 +23,6 @@ runnable = false
 command = "mdbook-toc"
 renderer = ["html"]
 
+[preprocessor.mermaid]
+command = "mdbook-mermaid"
+
diff --git a/doc/src/architecture/architecture.md b/doc/src/architecture/architecture.md
index f06f45f56..e9c576f64 100644
--- a/doc/src/architecture/architecture.md
+++ b/doc/src/architecture/architecture.md
@@ -47,6 +47,20 @@ Deferred (future):
 
 ## Release Cycle
 
+```mermaid
+gantt
+    title Release Cycle
+    dateFormat  DD-MM-YYYY
+    axisFormat  %m-%y
+    section Phases
+    Dcon0            :done, d0, 01-01-2022, 01-04-2022
+    Dcon1            :      d1, after d0,   23-12-2022
+    Dcon2            :      d2, 23-08-2022, 23-02-2023
+    Dcon3            :      d3, after d2,   60d
+    Dcon4            :      d4, after d3,   14d
+    Dcon5            :      d5, after d4,   7d
+```
+
 <table>
     <tr>
         <th>Phase</th>