-
Notifications
You must be signed in to change notification settings - Fork 41
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: re organize user manual section in docs website
- Loading branch information
Showing
29 changed files
with
121 additions
and
107 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
title: Develop | ||
--- | ||
|
||
import DocCardList from "@theme/DocCardList"; | ||
|
||
The Mithril network consists of three main components: | ||
|
||
- **Mithril aggregator**: | ||
|
||
This node coordinates the production of the Cardano snapshot archives, working alongside the Mithril signer and Cardano nodes to generate associated certificates using Mithril multi-signatures. | ||
|
||
- **Mithril signer**: | ||
|
||
This node produces individual signatures, which the Mithril aggregator combines into a multi-signature. It operates in conjunction with a Cardano node (run by an SPO) holding stake in the network. | ||
|
||
- **Mithril client**: | ||
|
||
This node verifies and restores a snapshot along with other types of data, facilitating lightning-fast bootstrapping of a Cardano full node. | ||
|
||
<DocCardList /> | ||
|
||
:::tip | ||
|
||
For more information about the Mithril protocol, refer to the [about Mithril](../mithril-protocol/protocol.md) section. | ||
|
||
::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
{ | ||
"label": "Develop", | ||
"collapsible": true, | ||
"collapsed": false, | ||
"position": 4 | ||
} |
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
3 changes: 1 addition & 2 deletions
3
...ot/mithril/mithril-protocol/simulation.md → ...oot/manual/develop/protocol-simulation.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
...ual/getting-started/run-mithril-devnet.md → ...root/manual/develop/run-mithril-devnet.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,8 @@ | ||
--- | ||
sidebar_position: 4 | ||
sidebar_position: 2 | ||
--- | ||
|
||
# Run a private Mithril network | ||
# Run a private network | ||
|
||
:::info | ||
|
||
|
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
title: Getting Started | ||
--- | ||
|
||
import DocCardList from "@theme/DocCardList"; | ||
|
||
This section is for users looking to utilize Mithril snapshots to accelerate the bootstrapping and synchronization of Cardano nodes. It outlines the prerequisites and provides a step-by-step tutorial for setting up the environment and bootstrapping a node. | ||
|
||
<DocCardList /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
9 changes: 9 additions & 0 deletions
9
docs/website/root/manual/getting-started/network-configurations.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
sidebar_position: 2 | ||
--- | ||
|
||
import NetworksMatrix from '../../networks-matrix.md'; | ||
|
||
# Network configurations | ||
|
||
<NetworksMatrix /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
sidebar_position: 1 | ||
--- | ||
|
||
import NetworksMatrix from '../../networks-matrix.md'; | ||
import CompiledBinaries from '../../compiled-binaries.md' | ||
|
||
# Prerequisites | ||
|
||
To begin the setup, ensure the following components and tools are installed: | ||
|
||
- A Linux (preferred) or macOS computer | ||
|
||
- A [correctly configured](https://www.rust-lang.org/learn/get-started) Rust toolchain (latest stable version) | ||
|
||
- A recent version of [Docker Engine](https://docs.docker.com/engine/install/) | ||
|
||
- A recent version of [Docker Compose](https://docs.docker.com/compose/install/) | ||
|
||
- A recent version of [`jq`](https://stedolan.github.io/jq/) (1.6+) | ||
|
||
These requirements will help ensure a smooth setup and configuration process. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
title: Operate | ||
--- | ||
|
||
import DocCardList from "@theme/DocCardList"; | ||
|
||
As a stake pool operator (SPO), you can participate in the Mithril network to help maintain it by creating multi-signatures for blockchain snapshots. To do this, you will need to join the Mithril network as an active SPO and run a Mithril signer node. | ||
|
||
<DocCardList /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
{ | ||
"label": "Operate", | ||
"collapsible": true, | ||
"collapsed": false, | ||
"position": 3 | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,78 +1,27 @@ | ||
--- | ||
sidebar_position: 1 | ||
sidebar_label: Welcome | ||
--- | ||
|
||
# User manual | ||
# Welcome | ||
|
||
Welcome to the **Mithril** user manual! | ||
Mithril is a stake-based multi-signature protocol designed to enhance blockchain efficiency and scalability. By enabling the secure aggregation of cryptographic signatures, it addresses the need for fast synchronization of Cardano nodes and state validation without compromising decentralization or security. | ||
|
||
Let's discover **Mithril in less than five minutes**. | ||
Mithril achieves this by generating snapshots of the blockchain state, which can be certified using aggregated signatures. These signatures rely on a lottery mechanism proportional to stake, ensuring that a quorum of the network participates. This multi-signature process reduces computational overhead, enabling light clients and applications to synchronize quickly and efficiently. | ||
|
||
## Introduction | ||
## Who is Mithril for? | ||
|
||
A **Mithril network** consists of three main components: | ||
Whether you are a stake pool operator (SPO), a full node user, or working with lightweight wallets, Mithril provides tools to streamline operations without compromising security. | ||
|
||
- **Mithril aggregator**: | ||
**Full node and wallet users.** Mithril’s certified snapshots enable the quick synchronization of a Cardano node. This allows bypassing the time-consuming process of verifying the entire blockchain from scratch, improving the startup experience for full nodes like Daedalus. | ||
|
||
This node coordinates the production of the Cardano snapshot archives, working alongside Mithril signer and Cardano nodes to generate associated certificates using Mithril multi-signatures. | ||
**Light clients and decentralized applications (DApps).** Light wallets, mobile apps, and sidechains can utilize Mithril snapshots for secure data synchronization. These snapshots allow clients to operate efficiently with fewer resources while maintaining security assurances. | ||
|
||
- **Mithril signer**: | ||
**Service providers and scaling protocols.** Mithril offers synchronization and interoperability solutions, enabling bridges and scaling protocols to stay updated with the blockchain state securely and with minimal overhead. | ||
|
||
This node is responsible for producing individual signatures, which are then combined into a multi-signature by the Mithril aggregator. It operates in conjunction with a Cardano node (run by a stake pool operator (SPO)) holding stake in the network. | ||
**SPOs.** SPOs can participate in creating multi-signatures for blockchain snapshots by running a Mithril signer. This contribution strengthens network security and supports faster node bootstrapping. | ||
|
||
- **Mithril client**: | ||
Dive into the manual to explore how to: | ||
|
||
This node verifies and restores a snapshot, facilitating lightning-fast bootstrapping of a Cardano full node. It plays a crucial role in ensuring the efficiency of the network. | ||
|
||
:::tip | ||
|
||
For more information about the **Mithril protocol**, see this section [about Mithril](../mithril/intro.md). | ||
|
||
::: | ||
|
||
## Get started | ||
|
||
To get started with the setup, make sure you have the following components and tools: | ||
|
||
- A Linux (preferred) or macOS computer | ||
|
||
- A [correctly configured](https://www.rust-lang.org/learn/get-started) Rust toolchain (latest stable version) | ||
|
||
- A recent version of [Docker Engine](https://docs.docker.com/engine/install/) | ||
|
||
- A recent version of [Docker Compose](https://docs.docker.com/compose/install/) | ||
|
||
- A recent version of [`jq`](https://stedolan.github.io/jq/) (1.6+) | ||
|
||
Having these requirements in place will enable you to proceed smoothly with the setup and configuration for your project. | ||
|
||
## Read the user manual | ||
|
||
In the [**Getting started**](/doc/category/getting-started) guide in the user manual, you will find tutorials for: | ||
|
||
- [Bootstrapping a Cardano node](./getting-started/bootstrap-cardano-node.md) on `testnet` | ||
|
||
- [Running a Mithril signer node as an SPO](./getting-started/run-signer-node.md) on `testnet` | ||
|
||
- [Running a private Mithril network](./getting-started/run-mithril-devnet.md) on `devnet` | ||
|
||
In the [**Developer docs**](/doc/category/developer-docs), you will find documentation for: | ||
|
||
- The **Mithril network nodes**: | ||
|
||
- [**Mithril aggregator node**](./developer-docs/nodes/mithril-aggregator.md) developer documentation | ||
- [**Mithril signer node**](./developer-docs/nodes/mithril-signer.md) developer documentation | ||
- [**Mithril client node**](./developer-docs/nodes/mithril-client.md) developer documentation | ||
|
||
- The [API reference](./developer-docs/references.md) guide. | ||
|
||
:::tip | ||
|
||
If you need any assistance, don't hesitate to contact the **Mithril** team: | ||
|
||
- [GitHub discussions](https://github.com/input-output-hk/mithril/discussions) | ||
|
||
- [Stack Exchange](https://cardano.stackexchange.com/questions/tagged/mithril) | ||
|
||
::: | ||
- [set up](/doc/category/getting-started/) | ||
- [operate](/doc/category/operate) | ||
- and [develop](/doc/category/develop/) with Mithril. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters