Merge pull request #2160 from input-output-hk/jpraynaud/2154-update-doc-website-about-mithril

Docs: reorganize `About Mithril` section in docs website

Author: jpraynaud

README.md

@@ -108,7 +108,7 @@ Should you have any questions, ideas or issues, we would like to hear from you:
 - #ask-mithril on the IOG [Discord server](https://discord.gg/5kaErDKDRq)
 - Create a GitHub [Discussion](https://github.com/input-output-hk/mithril/discussions)
 - Create a GitHub [Issue](https://github.com/input-output-hk/mithril/issues/new)
-- Ask on Cardano [StackExchange](https://cardano.stackexchange.com/questions/tagged/mithril) using the `mithril` tag
+- Ask on Cardano [StackExchange](https://cardano.stackexchange.com/search?q=mithril) using the `mithril` tag
 
 When contributing to this project and interacting with others, please follow our [Code of Conduct](./CODE-OF-CONDUCT.md) and our [Contributing Guidelines](./CONTRIBUTING.md).
 

docs/website/docusaurus.config.js

@@ -147,6 +147,46 @@ const config = {
             to: "/manual/develop/references",
             from: ["/manual/developer-docs/references"],
           },
+          {
+            to: "/mithril/advanced/mithril-protocol",
+            from: ["/category/mithril-protocol"],
+          },
+          {
+            to: "/mithril/advanced/mithril-protocol/protocol",
+            from: ["/mithril/mithril-protocol/protocol"],
+          },
+          {
+            to: "/mithril/advanced/mithril-protocol/certificates",
+            from: ["/mithril/mithril-protocol/certificates"],
+          },
+          {
+            to: "/mithril/advanced/mithril-protocol/security",
+            from: ["/mithril/mithril-protocol/security"],
+          },
+          {
+            to: "/mithril/advanced/mithril-network/",
+            from: ["/category/mithril-network"],
+          },
+          {
+            to: "/mithril/advanced/mithril-network/architecture",
+            from: ["/mithril/mithril-network/architecture"],
+          },
+          {
+            to: "/mithril/advanced/mithril-network/aggregator",
+            from: ["/mithril/mithril-network/aggregator"],
+          },
+          {
+            to: "/mithril/advanced/mithril-network/signer",
+            from: ["/mithril/mithril-network/signer"],
+          },
+          {
+            to: "/mithril/advanced/mithril-network/client",
+            from: ["/mithril/mithril-network/client"],
+          },
+          {
+            to: "/mithril/advanced/threat-model",
+            from: ["/mithril/threat-model"],
+          },
         ],
       },
     ],
@@ -236,7 +276,7 @@ const config = {
               },
               {
                 label: "Stack Exchange",
-                href: "https://cardano.stackexchange.com/questions/tagged/mithril",
+                href: "https://cardano.stackexchange.com/search?q=mithril",
               },
             ],
           },

docs/website/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mithril-doc",
-  "version": "0.1.46",
+  "version": "0.1.47",
   "private": true,
   "scripts": {
     "docusaurus": "docusaurus",

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).

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.
 
 :::

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.
 
 :::
 

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.
 
 :::
 

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.
 

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.
 

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.