docs: create 'Advanced' sub section of 'About Mithril'

jpraynaud · jpraynaud · commit 0b9c55a74ef7 · 2024-12-04T18:26:54.000+01:00
diff --git a/docs/website/root/glossary.md b/docs/website/root/glossary.md
@@ -34,7 +34,7 @@ A Cardano transactions set snapshot represents, in a succinct way, the Cardano t
 
 The Mithril aggregator combines the produced [multi-signature](#multi-signature) and some metadata into a Mithril certificate that will be later used by the [Mithril client](#mithril-client) to verify the authenticity of a [snapshot](#snapshot). The certificates are chained so that the [stake distribution](#stake-distribution) used to create the signatures is verifiably genuine.
 
-> More information is available on the [certificates page](./mithril/mithril-protocol/certificates.md).
+> More information is available on the [certificates page](./mithril/advanced/mithril-protocol/certificates.md).
 
 ## Epoch
 
@@ -48,45 +48,45 @@ Inside the database of a [Cardano node](#cardano-node), the blockchain state is
 
 For each [beacon](#beacon), the [Mithril signers](#mithril-signer) will compute on their end a message representing the blockchain state, and sign it with their verification keys to create an [individual signature](#individual-signature). Upon winning one or more lotteries, the Mithril signer will be able to use this individual signature to participate in the creation of a [multi-signature](#multi-signature).
 
-> More information is available on the [protocol page](./mithril/mithril-protocol/protocol.md).
+> More information is available on the [protocol page](./mithril/advanced/mithril-protocol/protocol.md).
 
 ## Mithril aggregator
 
 The Mithril aggregator is a trustless node of the [Mithril network](#mithril-network) that orchestrates the work of the [Mithril signer](#mithril-signer) nodes and gathers their [individual signatures](#individual-signature) to produce [Mithril multi-signatures](#multi-signature) and their associated [certificates](#certificate).
 
 It is also in charge of creating and storing the [snapshot](#snapshot) archive.
 
-> More information is available on the [aggregator page](./mithril/mithril-network/aggregator.md).
+> More information is available on the [aggregator page](./mithril/advanced/mithril-network/aggregator.md).
 
 ## Mithril client
 
 The Mithril client node within the [Mithril network](#mithril-network) is used to restore a [Cardano full node](#cardano-node) by retrieving, from a [Mithril aggregator](#mithril-aggregator), a remote [snapshot](#snapshot) and its [certificate](#certificate) chain. Finally, it is used to verify snapshot and certificate validity using the Mithril cryptographic primitives.
 
-> More information is available on the [client page](./mithril/mithril-network/client.md).
+> More information is available on the [client page](./mithril/advanced/mithril-network/client.md).
 
 ## Mithril network
 
 In its current version, the Mithril network is a network of nodes responsible for creating [snapshots](#snapshot) and [certificates](#certificate) that enable fast bootstrap of a [Cardano node](#cardano-node). It runs on top of the [Cardano network](#cardano-network).
 
-> More information is available on the [architecture page](./mithril/mithril-network/architecture.md).
+> More information is available on the [architecture page](./mithril/advanced/mithril-network/architecture.md).
 
 ## Mithril protocol
 
 The Mithril protocol allows stakeholders in a proof-of-stake blockchain network to individually sign messages that are aggregated into a multi-signature which guarantees that they represent a minimum share of the total stake.
 
-> More information is on the [protocol page](./mithril/mithril-protocol/protocol.md).
+> More information is on the [protocol page](./mithril/advanced/mithril-protocol/protocol.md).
 
 ## Mithril signer
 
 The Mithril signer is a node of the [Mithril network](#mithril-network) that works transparently on top of the [stake pool operator](#stake-pool-operator-spo) Cardano nodes and which individually signs the ledger state.
 
-> More information is available on the [signer page](./mithril/mithril-network/signer.md).
+> More information is available on the [signer page](./mithril/advanced/mithril-network/signer.md).
 
 ## Multi-signature
 
 The Mithril multi-signature is an aggregate of [individual signatures](#individual-signature), which guarantees that a minimum share of the total stake has participated in its creation.
 
-> More information is available on the [protocol page](./mithril/mithril-protocol/protocol.md).
+> More information is available on the [protocol page](./mithril/advanced/mithril-protocol/protocol.md).
 
 ## Snapshot
 
@@ -106,4 +106,4 @@ A stake pool operator, also known as an SPO, represents a party that holds (via
 
 To create [individual signatures](#individual-signature), [Mithril signers](#mithril-signer) must register their signing public key: the verification key. To guarantee their genuineness, they are signed by the associated [Cardano key pair](#cardano-key-pair). It is worth mentioning that a [Mithril signer](#mithril-signer) must be aware of the verification keys of all the other Mithril signers to produce valid individual signatures.
 
-> More information is available on the [protocol page](./mithril/mithril-protocol/protocol.md).
+> More information is available on the [protocol page](./mithril/advanced/mithril-protocol/protocol.md).
diff --git a/docs/website/root/manual/develop/README.mdx b/docs/website/root/manual/develop/README.mdx
@@ -22,6 +22,6 @@ This node verifies and restores a snapshot along with other types of data, facil
 
 :::tip
 
-For more information about the Mithril protocol, refer to the [about Mithril](../../mithril/mithril-protocol/protocol.md) section.
+For more information about the Mithril protocol, refer to the [about Mithril](../../mithril/advanced/mithril-protocol/protocol.md) section.
 
 :::
diff --git a/docs/website/root/manual/develop/nodes/mithril-aggregator.md b/docs/website/root/manual/develop/nodes/mithril-aggregator.md
@@ -14,9 +14,9 @@ Mithril aggregator is responsible for collecting individual signatures from the
 
 :::tip
 
-- For more information about the **Mithril network**, please see the [architecture](../../../mithril/mithril-network/architecture.md) overview
+- For more information about the **Mithril network**, please see the [architecture](../../../mithril/advanced/mithril-network/architecture.md) overview
 
-- For more information about the **Mithril aggregator**, please see the [aggregator node](../../../mithril/mithril-network/aggregator.md) overview.
+- For more information about the **Mithril aggregator**, please see the [aggregator node](../../../mithril/advanced/mithril-network/aggregator.md) overview.
 
 :::
 
diff --git a/docs/website/root/manual/develop/nodes/mithril-client-library-wasm.md b/docs/website/root/manual/develop/nodes/mithril-client-library-wasm.md
@@ -20,7 +20,7 @@ It is responsible for handling the different types of data certified by Mithril
 
 :::tip
 
-- For more information about the **Mithril network**, please see the [architecture](../../../mithril/mithril-network/architecture.md) overview.
+- For more information about the **Mithril network**, please see the [architecture](../../../mithril/advanced/mithril-network/architecture.md) overview.
 
 :::
 
diff --git a/docs/website/root/manual/develop/nodes/mithril-client-library.md b/docs/website/root/manual/develop/nodes/mithril-client-library.md
@@ -20,9 +20,9 @@ It is responsible for handling the different types of data certified by Mithril
 
 :::tip
 
-- For more information about the **Mithril network**, please see the [architecture](../../../mithril/mithril-network/architecture.md) overview
+- For more information about the **Mithril network**, please see the [architecture](../../../mithril/advanced/mithril-network/architecture.md) overview
 
-- For more information about the **Mithril client** node, please see [this overview](../../../mithril/mithril-network/client.md)
+- For more information about the **Mithril client** node, please see [this overview](../../../mithril/advanced/mithril-network/client.md)
 
 - Check out the [`Bootstrap a Cardano node`](../../getting-started/bootstrap-cardano-node.md) guide.
 
diff --git a/docs/website/root/manual/develop/nodes/mithril-client.md b/docs/website/root/manual/develop/nodes/mithril-client.md
@@ -15,10 +15,10 @@ Mithril client is responsible for restoring the **Cardano** blockchain on an emp
 :::tip
 
 - For more information about the **Mithril network**, please see
-  the [architecture](../../../mithril/mithril-network/architecture.md) overview
+  the [architecture](../../../mithril/advanced/mithril-network/architecture.md) overview
 
 - For more information about the **Mithril client** node, please
-  see [this overview](../../../mithril/mithril-network/client.md)
+  see [this overview](../../../mithril/advanced/mithril-network/client.md)
 
 - Check out the [`Bootstrap a Cardano node`](../../getting-started/bootstrap-cardano-node.md) guide.
 
diff --git a/docs/website/root/manual/develop/nodes/mithril-signer.md b/docs/website/root/manual/develop/nodes/mithril-signer.md
@@ -14,9 +14,9 @@ Mithril signer is responsible for producing individual signatures that are colle
 
 :::tip
 
-- For more information about the **Mithril network**, please see the [architecture](../../../mithril/mithril-network/architecture.md) overview
+- For more information about the **Mithril network**, please see the [architecture](../../../mithril/advanced/mithril-network/architecture.md) overview
 
-- For more information about the **Mithril signer** node, please see [this overview](../../../mithril/mithril-network/signer.md)
+- For more information about the **Mithril signer** node, please see [this overview](../../../mithril/advanced/mithril-network/signer.md)
 
 - Check out the [`Run a Mithril signer node`](../../operate/run-signer-node.md) guide.
 
diff --git a/docs/website/root/manual/develop/protocol-simulation.md b/docs/website/root/manual/develop/protocol-simulation.md
@@ -294,6 +294,6 @@ Party #0: aggregate signature not found 7724e03fb8d84a376a43b8f41518a11c
 
 :::tip
 
-For more information about the Mithril protocol, refer to the [about Mithril](../../mithril/mithril-protocol/protocol.md) section.
+For more information about the Mithril protocol, refer to the [about Mithril](../../mithril/advanced/mithril-protocol/protocol.md) section.
 
 :::
diff --git a/docs/website/root/mithril/advanced/README.mdx b/docs/website/root/mithril/advanced/README.mdx
@@ -0,0 +1,5 @@
+---
+title: Advanced
+---
+
+import DocCardList from "@theme/DocCardList";
diff --git a/docs/website/root/mithril/advanced/_category_.json b/docs/website/root/mithril/advanced/_category_.json
@@ -0,0 +1,6 @@
+{
+  "label": "Advanced",
+  "collapsible": true,
+  "collapsed": false,
+  "position": 3
+}
diff --git a/docs/website/root/mithril/advanced/mithril-network/README.mdx b/docs/website/root/mithril/advanced/mithril-network/README.mdx
@@ -0,0 +1,5 @@
+---
+title: Mithril network
+---
+
+import DocCardList from "@theme/DocCardList";
diff --git a/docs/website/root/mithril/advanced/mithril-network/_category_.json b/docs/website/root/mithril/advanced/mithril-network/_category_.json
@@ -0,0 +1,6 @@
+{
+  "label": "Mithril network",
+  "collapsible": true,
+  "collapsed": false,
+  "position": 2
+}
diff --git a/docs/website/root/mithril/advanced/mithril-network/aggregator.md b/docs/website/root/mithril/advanced/mithril-network/aggregator.md
@@ -3,7 +3,7 @@ sidebar_position: 2
 sidebar_label: Mithril aggregator
 ---
 
-# Mithril aggregator node
+# Mithril aggregator
 
 :::info
 
@@ -15,7 +15,7 @@ A **Mithril aggregator** is a trustless node responsible for coordinating the ac
 
 - For more information about the **Mithril protocol**, see the [protocol in depth](../mithril-protocol/protocol.md) overview.
 
-- For more information about the **Mithril aggregator**, see the [developer manual](../../manual/develop/nodes/mithril-aggregator.md).
+- For more information about the **Mithril aggregator**, see the [developer manual](../../../manual/develop/nodes/mithril-aggregator.md).
 
 :::
 
diff --git a/docs/website/root/mithril/advanced/mithril-network/architecture-c4.puml b/docs/website/root/mithril/advanced/mithril-network/architecture-c4.puml
diff --git a/docs/website/root/mithril/advanced/mithril-network/architecture.md b/docs/website/root/mithril/advanced/mithril-network/architecture.md
@@ -3,7 +3,7 @@ sidebar_position: 1
 sidebar_label: Architecture
 ---
 
-# Mithril network architecture
+# Architecture
 
 :::info
 
@@ -33,7 +33,7 @@ The network is composed of the following nodes:
 
 - **Mithril relay**:
 
-> A forward proxy that is used to secure communications between the Mithril signer and the Mithril aggregator. More information is available in the [Mithril signer deployment model](../../manual/operate/run-signer-node.md#mithril-signer-deployment-model) section.
+> A forward proxy that is used to secure communications between the Mithril signer and the Mithril aggregator. More information is available in the [Mithril signer deployment model](../../../manual/operate/run-signer-node.md#mithril-signer-deployment-model) section.
 
 :::tip
 
diff --git a/docs/website/root/mithril/advanced/mithril-network/client.md b/docs/website/root/mithril/advanced/mithril-network/client.md
@@ -3,7 +3,7 @@ sidebar_position: 4
 sidebar_label: Mithril client
 ---
 
-# Mithril client node
+# Mithril client
 
 :::info
 
@@ -18,7 +18,7 @@ The Mithril client node is used to list, show or verify artifacts certified by M
 
 - For more information about the Mithril protocol, see the [protocol in depth](../mithril-protocol/protocol.md) overview.
 
-- For more information about the Mithril client, see the [developer manual](../../manual/develop/nodes/mithril-client.md).
+- For more information about the Mithril client, see the [developer manual](../../../manual/develop/nodes/mithril-client.md).
 
 :::
 
diff --git a/docs/website/root/mithril/advanced/mithril-network/images/aggregator-runtime.jpg b/docs/website/root/mithril/advanced/mithril-network/images/aggregator-runtime.jpg
diff --git a/docs/website/root/mithril/advanced/mithril-network/images/architecture.svg b/docs/website/root/mithril/advanced/mithril-network/images/architecture.svg
diff --git a/docs/website/root/mithril/advanced/mithril-network/images/signer-runtime.jpg b/docs/website/root/mithril/advanced/mithril-network/images/signer-runtime.jpg
diff --git a/docs/website/root/mithril/advanced/mithril-network/images/signer-workflow.png b/docs/website/root/mithril/advanced/mithril-network/images/signer-workflow.png
diff --git a/docs/website/root/mithril/advanced/mithril-network/signer.md b/docs/website/root/mithril/advanced/mithril-network/signer.md
@@ -3,7 +3,7 @@ sidebar_position: 3
 sidebar_label: Mithril signer
 ---
 
-# Mithril signer node
+# Mithril signer
 
 :::info
 
@@ -15,7 +15,7 @@ The Mithril signer is a node that works transparently on top of the stake pool o
 
 - For more information about the **Mithril protocol**, see the [protocol in depth](../mithril-protocol/protocol.md) overview.
 
-- For more information about the **Mithril signer**, see the [developer manual](../../manual/develop/nodes/mithril-signer.md).
+- For more information about the **Mithril signer**, see the [developer manual](../../../manual/develop/nodes/mithril-signer.md).
 
 :::
 
diff --git a/docs/website/root/mithril/advanced/mithril-protocol/README.mdx b/docs/website/root/mithril/advanced/mithril-protocol/README.mdx
@@ -0,0 +1,5 @@
+---
+title: Mithril protocol
+---
+
+import DocCardList from "@theme/DocCardList";
diff --git a/docs/website/root/mithril/advanced/mithril-protocol/_category_.json b/docs/website/root/mithril/advanced/mithril-protocol/_category_.json
@@ -0,0 +1,6 @@
+{
+  "label": "Mithril protocol",
+  "collapsible": true,
+  "collapsed": false,
+  "position": 1
+}
diff --git a/docs/website/root/mithril/advanced/mithril-protocol/certificates.md b/docs/website/root/mithril/advanced/mithril-protocol/certificates.md
@@ -1,9 +1,9 @@
 ---
 sidebar_position: 2
-sidebar_label: Certificate chain in depth
+sidebar_label: Certificate chain design
 ---
 
-# Mithril certificate chain in depth
+# Certificate chain design
 
 ## Introduction
 
@@ -61,7 +61,7 @@ The message `MSG(p,n)` is a map of multiple values associated with their respect
 
 :::note
 
-The **trigger** represents the instant at which a certificate should be created. It is combined with at least the associated **epoch** to create a [**beacon**](../../glossary.md#beacon) of the certificate. In the current implementation of the Cardano node database snapshot, this trigger is a new [**immutable file number**](../../glossary.md#immutable-file-number).
+The **trigger** represents the instant at which a certificate should be created. It is combined with at least the associated **epoch** to create a [**beacon**](../../../glossary.md#beacon) of the certificate. In the current implementation of the Cardano node database snapshot, this trigger is a new [**immutable file number**](../../../glossary.md#immutable-file-number).
 
 :::
 
diff --git a/docs/website/root/mithril/advanced/mithril-protocol/images/certificate-chain.jpg b/docs/website/root/mithril/advanced/mithril-protocol/images/certificate-chain.jpg
diff --git a/docs/website/root/mithril/advanced/mithril-protocol/protocol.md b/docs/website/root/mithril/advanced/mithril-protocol/protocol.md
@@ -1,9 +1,9 @@
 ---
 sidebar_position: 1
-sidebar_label: Protocol in depth
+sidebar_label: Protocol phases
 ---
 
-# Mithril protocol in depth
+# Protocol phases
 
 :::info
 
@@ -13,7 +13,7 @@ Mithril is based on the research paper [Mithril: Stake-based Threshold Multisign
 
 :::info
 
-You can interact with the **Mithril protocol** through the [protocol simulation](../../manual/develop/protocol-simulation.md). This will help you understand participants' interactions, multi-signature creation, and the influence of protocol parameters.
+You can interact with the **Mithril protocol** through the [protocol simulation](../../../manual/develop/protocol-simulation.md). This will help you understand participants' interactions, multi-signature creation, and the influence of protocol parameters.
 
 :::
 
diff --git a/docs/website/root/mithril/advanced/mithril-protocol/security.md b/docs/website/root/mithril/advanced/mithril-protocol/security.md
@@ -1,6 +1,6 @@
 ---
 sidebar_position: 3
-sidebar_label: Security
+sidebar_label: Protocol security
 ---
 
 # Protocol security
diff --git a/docs/website/root/mithril/advanced/threat-model.md b/docs/website/root/mithril/advanced/threat-model.md
@@ -1,9 +1,9 @@
 ---
 sidebar_position: 3
-sidebar_label: Mithril threat model
+sidebar_label: Threat model analysis
 ---
 
-# Mithril threat model
+# Threat model analysis
 
 :::danger
 
diff --git a/docs/website/root/mithril/intro.md b/docs/website/root/mithril/intro.md
@@ -27,23 +27,23 @@ In this guide, you will find:
 
 - The **Mithril protocol** documentation:
 
-  - [Mithril protocol in depth](./mithril-protocol/protocol.md)
+  - [Mithril protocol in depth](./advanced/mithril-protocol/protocol.md)
 
-  - [Mithril certificate chain in depth](./mithril-protocol/certificates.md)
+  - [Mithril certificate chain in depth](./advanced/mithril-protocol/certificates.md)
 
   - An interactive protocol discovery through the [Mithril simulation](../manual/develop/protocol-simulation.md)
 
 - The **Mithril network** documentation:
 
-  - [Mithril network architecture](./mithril-network/architecture.md)
+  - [Mithril network architecture](./advanced/mithril-network/architecture.md)
 
-  - [Mithril aggregator node](./mithril-network/aggregator.md)
+  - [Mithril aggregator node](./advanced/mithril-network/aggregator.md)
 
-  - [Mithril signer node](./mithril-network/signer.md)
+  - [Mithril signer node](./advanced/mithril-network/signer.md)
 
-  - [Mithril client node](./mithril-network/client.md)
+  - [Mithril client node](./advanced/mithril-network/client.md)
 
-- The [**Mithril threat model**](./threat-model)
+- The [**Mithril threat model**](./advanced/threat-model)
 
 :::tip
 
diff --git a/docs/website/root/mithril/mithril-network/_category_.json b/docs/website/root/mithril/mithril-network/_category_.json
diff --git a/docs/website/root/mithril/mithril-protocol/_category_.json b/docs/website/root/mithril/mithril-protocol/_category_.json

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +title: Advanced
 +---
++
 +import DocCardList from "@theme/DocCardList";