docs: Add docs for block syncing (#33)

* Added Sync specs

* Added Sync specs image

* add more context for ValueSync

* replace image with Mermaid diagram

* Update docs/specs/Syncing.md

Co-authored-by: Jasmina Malicevic <jasmina.dustinac@gmail.com>

* update sync request handling

* move Syncing to the docs

* update sync response handling

* update sync request and add TODO

* add todo

* update example flow

* update reth sync overview

* ProcessSyncedValue no longer calls newPayload

* update sync request handling

* update example flow

* add config details

* update headers

* explain why getPayloadBodiesByRange uses count of 1

* Update docs/operational-docs/src/architecture/syncing.md

Co-authored-by: Jasmina Malicevic <jasmina.dustinac@gmail.com>

* Update docs/operational-docs/src/architecture/syncing.md

Co-authored-by: Jasmina Malicevic <jasmina.dustinac@gmail.com>

* Update docs/operational-docs/src/architecture/syncing.md

Co-authored-by: Jasmina Malicevic <jasmina.dustinac@gmail.com>

---------

Co-authored-by: Marius Poke <marius.poke@posteo.de>
Co-authored-by: Jasmina Malicevic <jasmina.dustinac@gmail.com>

Author: 3 people

docs/operational-docs/book.toml

@@ -10,11 +10,15 @@ create-missing = true
 
 [preprocessor.links]
 
+[preprocessor.mermaid]
+command = "mdbook-mermaid"
+
 [output.html]
 default-theme = "light"
 preferred-dark-theme = "navy"
 git-repository-url = "https://github.com/informalsystems/emerald"
 additional-css = ["theme/custom.css"]
+additional-js = ["mermaid.min.js", "mermaid-init.js"]
 
 [output.html.search]
 enable = true

docs/operational-docs/mermaid-init.js

@@ -0,0 +1,39 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+(() => {
+    const darkThemes = ['ayu', 'navy', 'coal'];
+    const lightThemes = ['light', 'rust'];
+
+    const classList = document.getElementsByTagName('html')[0].classList;
+
+    let lastThemeWasLight = true;
+    for (const cssClass of classList) {
+        if (darkThemes.includes(cssClass)) {
+            lastThemeWasLight = false;
+            break;
+        }
+    }
+
+    const theme = lastThemeWasLight ? 'default' : 'dark';
+    mermaid.initialize({ startOnLoad: true, theme });
+
+    // Simplest way to make mermaid re-render the diagrams in the new theme is via refreshing the page
+
+    for (const darkTheme of darkThemes) {
+        document.getElementById(darkTheme).addEventListener('click', () => {
+            if (lastThemeWasLight) {
+                window.location.reload();
+            }
+        });
+    }
+
+    for (const lightTheme of lightThemes) {
+        document.getElementById(lightTheme).addEventListener('click', () => {
+            if (!lastThemeWasLight) {
+                window.location.reload();
+            }
+        });
+    }
+})();