Skip to content

Commit c936b60

Browse files
authored
Merge pull request #2102 from input-output-hk/jpraynaud/2101-update-doc-website-user-manual
Docs: reorganize user manual section in docs website
2 parents 57af397 + 6e6c776 commit c936b60

File tree

75 files changed

+739
-661
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+739
-661
lines changed

docs/website/docusaurus.config.js

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,57 @@ const config = {
9494
sortPosts: "descending",
9595
},
9696
],
97+
[
98+
"@docusaurus/plugin-client-redirects",
99+
{
100+
redirects: [
101+
{
102+
to: "/manual/develop/protocol-simulation",
103+
from: ["/mithril/mithril-protocol/simulation"],
104+
},
105+
{
106+
to: "/manual/operate/become-mithril-spo",
107+
from: ["/manual/getting-started/SPO-on-boarding-guide"],
108+
},
109+
{
110+
to: "/manual/operate/run-signer-node",
111+
from: ["/manual/getting-started/run-signer-node"],
112+
},
113+
{
114+
to: "/manual/develop/run-mithril-devnet",
115+
from: ["/manual/getting-started/run-mithril-devnet"],
116+
},
117+
{
118+
to: "/manual/develop/",
119+
from: ["/category/developer-docs"],
120+
},
121+
{
122+
to: "/manual/develop/nodes/mithril-aggregator",
123+
from: ["/manual/developer-docs/nodes/mithril-aggregator"],
124+
},
125+
{
126+
to: "/manual/develop/nodes/mithril-signer",
127+
from: ["/manual/developer-docs/nodes/mithril-signer"],
128+
},
129+
{
130+
to: "/manual/develop/nodes/mithril-client",
131+
from: ["/manual/developer-docs/nodes/mithril-client"],
132+
},
133+
{
134+
to: "/manual/develop/nodes/mithril-client-library",
135+
from: ["/manual/developer-docs/nodes/mithril-client-library"],
136+
},
137+
{
138+
to: "/manual/develop/nodes/mithril-client-library-wasm",
139+
from: ["/manual/developer-docs/nodes/mithril-client-library-wasm"],
140+
},
141+
{
142+
to: "/manual/develop/references",
143+
from: ["/manual/developer-docs/references"],
144+
},
145+
],
146+
},
147+
],
97148
],
98149

99150
themeConfig:
@@ -103,7 +154,7 @@ const config = {
103154
announcementBar: {
104155
id: "announcement",
105156
content:
106-
'Participate in Mithril Protocol’s Mainnet Beta Launch! Follow our SPO on-boarding guide <a rel="noopener noreferrer" href="https://mithril.network/doc/manual/getting-started/SPO-on-boarding-guide">here</a> if you are interested!',
157+
'Participate in Mithril Protocol’s Mainnet Beta! Follow our SPO on-boarding guide <a rel="noopener noreferrer" href="https://mithril.network/doc/manual/operate/become-mithril-spo">here</a>!',
107158
backgroundColor: "#2e8555",
108159
textColor: "#f1f1f1",
109160
isCloseable: true,

docs/website/package-lock.json

Lines changed: 25 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/website/package.json

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "mithril-doc",
3-
"version": "0.1.44",
3+
"version": "0.1.45",
44
"private": true,
55
"scripts": {
66
"docusaurus": "docusaurus",
@@ -17,6 +17,8 @@
1717
},
1818
"dependencies": {
1919
"@docusaurus/core": "^3.6.0",
20+
"@docusaurus/plugin-sitemap": "^3.6.0",
21+
"@docusaurus/plugin-client-redirects": "^3.6.0",
2022
"@docusaurus/preset-classic": "^3.6.0",
2123
"@docusaurus/theme-mermaid": "^3.6.0",
2224
"clsx": "^2.1.1",
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: Develop
3+
---
4+
5+
import DocCardList from "@theme/DocCardList";
6+
7+
The Mithril network consists of three main components:
8+
9+
- **Mithril aggregator**:
10+
11+
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.
12+
13+
- **Mithril signer**:
14+
15+
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.
16+
17+
- **Mithril client**:
18+
19+
This node verifies and restores a snapshot along with other types of data, facilitating lightning-fast bootstrapping of a Cardano full node.
20+
21+
<DocCardList />
22+
23+
:::tip
24+
25+
For more information about the Mithril protocol, refer to the [about Mithril](../../mithril/mithril-protocol/protocol.md) section.
26+
27+
:::
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"label": "Develop",
3+
"collapsible": true,
4+
"collapsed": false,
5+
"position": 4
6+
}
Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
sidebar_position: 1
33
---
44

5-
import NetworksMatrix from '../../../networks-matrix.md';
65
import CompiledBinaries from '../../../compiled-binaries.md'
76

87
# Mithril aggregator node
@@ -15,31 +14,31 @@ Mithril aggregator is responsible for collecting individual signatures from the
1514

1615
:::tip
1716

18-
- For more information about the **Mithril network**, please see the [architecture](../../../mithril/mithril-network/architecture.md) overview.
17+
- For more information about the **Mithril network**, please see the [architecture](../../../mithril/mithril-network/architecture.md) overview
1918

2019
- For more information about the **Mithril aggregator**, please see the [aggregator node](../../../mithril/mithril-network/aggregator.md) overview.
2120

2221
:::
2322

24-
:::note Mithril networks
23+
:::info
2524

26-
<NetworksMatrix />
25+
The Mithril network configurations are available in the [**Network configurations**](../../getting-started/network-configurations.md) section of the user manual.
2726

2827
:::
2928

3029
## Resources
3130

32-
| Node | Source repository | Rust documentation | Docker packages | REST API |
33-
| :--------------------: | :--------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------: | :----------------------------------------: |
34-
| **Mithril aggregator** | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/tree/main/mithril-aggregator) | [:arrow_upper_right:](https://mithril.network/rust-doc/mithril_aggregator/index.html) | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/pkgs/container/mithril-aggregator) | [:arrow_upper_right:](/doc/aggregator-api) |
31+
| Node | Source repository | Rust documentation | Docker packages | REST API | Network configurations |
32+
| :--------------------: | :--------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------: | :----------------------------------------: | :--------------------------------------------------------------------: |
33+
| **Mithril aggregator** | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/tree/main/mithril-aggregator) | [:arrow_upper_right:](https://mithril.network/rust-doc/mithril_aggregator/index.html) | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/pkgs/container/mithril-aggregator) | [:arrow_upper_right:](/doc/aggregator-api) | [:arrow_upper_right:](../../getting-started/network-configurations.md) |
3534

36-
## Pre-requisites
35+
## Prerequisites
3736

38-
- Install the latest stable version of the [correctly configured](https://www.rust-lang.org/learn/get-started) Rust toolchain.
37+
- Install the latest stable version of the [correctly configured](https://www.rust-lang.org/learn/get-started) Rust toolchain
3938

40-
- Install Build Tools `build-essential` and `m4`. For example, on Ubuntu/Debian/Mint, run `sudo apt install build-essential m4`.
39+
- Install build tools `build-essential` and `m4`; for example, on Ubuntu/Debian/Mint, run `sudo apt install build-essential m4`
4140

42-
- Install OpenSSL development libraries. For example, on Ubuntu/Debian/Mint, run `apt install libssl-dev`.
41+
- Install OpenSSL development libraries; for example, on Ubuntu/Debian/Mint, run `apt install libssl-dev`.
4342

4443
## Download the source file
4544

@@ -59,7 +58,7 @@ Switch to the desired branch/tag:
5958

6059
```bash
6160
# Replace **YOUR_BUILD_BRANCH_OR_TAG** with the appropriate branch or tag name
62-
# Please refer to the **Build from** column of the **Mithril networks** table above
61+
# Please refer to the [**Network configurations**](http://mithril.network/manual/getting-started/network-configurations) section of the user manual
6362
git checkout **YOUR_BUILD_BRANCH_OR_TAG**
6463
```
6564

@@ -137,7 +136,7 @@ Options:
137136
--db-directory <DB_DIRECTORY>
138137
Directory of the Cardano node files
139138
--config-directory <CONFIG_DIRECTORY>
140-
Directory where configuration file is located [default: ./config]
139+
Directory where the configuration file is located [default: ./config]
141140
-h, --help
142141
Print help
143142
-V, --version
@@ -186,15 +185,15 @@ USAGE:
186185
OPTIONS:
187186
-h, --help Print help information
188187
SUBCOMMANDS:
189-
bootstrap Bootstrap a genesis certificate Test only usage
188+
bootstrap Bootstrap a genesis certificate test-only usage
190189
export Export payload to sign with genesis secret key
191190
help Print this message or the help of the given subcommand(s)
192191
import Import payload signed with genesis secret key and create & import a genesis certificate
193192
```
194193

195194
### Bootstrap sub-command (test-only)
196195

197-
You can run the 'genesis bootstrap' command in release mode with the default configuration, but **only in test mode**. This will enable the Mithril aggregator node to bootstrap a `genesis certificate`. After completing this operation, the Mithril aggregator will be capable of producing new snapshots and certificates.
196+
You can run the 'genesis bootstrap' command in release mode with the default configuration, but **only in test mode**. This will enable the Mithril aggregator node to bootstrap a `genesis certificate`. After completing this operation, the Mithril aggregator will be able to produce new snapshots and certificates.
198197

199198
```bash
200199
./mithril-aggregator genesis bootstrap
@@ -365,7 +364,7 @@ If you wish to delve deeper and access several levels of logs from the Mithril a
365364
- Add `-v` for some logs (WARN)
366365
- Add `-vv` for more logs (INFO)
367366
- Add `-vvv` for even more logs (DEBUG)
368-
- Add `-vvvv` for all logs (TRACE)
367+
- Add `-vvvv` for all logs (TRACE).
369368

370369
:::
371370

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
sidebar_position: 5
33
---
44

5-
import NetworksMatrix from '../../../networks-matrix.md';
65
import CompiledBinaries from '../../../compiled-binaries.md'
76

87
# Mithril client library WASM
@@ -11,12 +10,12 @@ import CompiledBinaries from '../../../compiled-binaries.md'
1110

1211
Mithril client library WASM can be used by Javascript developers to use the Mithril network in their web applications.
1312

14-
It is responsible for handling the different types of data certified by Mithril, and available through a Mithril aggregator:
13+
It is responsible for handling the different types of data certified by Mithril and available through a Mithril aggregator:
1514

16-
- [**Snapshot**](../../../glossary.md#snapshot): list and get.
17-
- [**Mithril stake distribution**](../../../glossary.md#stake-distribution): list and get.
18-
- [**Cardano transaction**](../../../glossary.md#cardano-transaction): list & get snapshots, get proofs.
19-
- [**Cardano stake distribution**](../../../glossary.md#stake-distribution): list, get and get by epoch.
15+
- [**Snapshot**](../../../glossary.md#snapshot): list and get
16+
- [**Mithril stake distribution**](../../../glossary.md#stake-distribution): list and get
17+
- [**Cardano transaction**](../../../glossary.md#cardano-transaction): list and get snapshots, get proofs
18+
- [**Cardano stake distribution**](../../../glossary.md#stake-distribution): list, get and get by epoch
2019
- [**Certificate**](../../../glossary.md#certificate): list, get, and chain validation.
2120

2221
:::
@@ -27,17 +26,17 @@ It is responsible for handling the different types of data certified by Mithril,
2726

2827
:::
2928

30-
:::note Mithril networks
29+
:::info
3130

32-
<NetworksMatrix />
31+
The Mithril network configurations are available in the [**Network configurations**](../../getting-started/network-configurations.md) section of the user manual.
3332

3433
:::
3534

3635
## Resources
3736

38-
| Node | Source repository | Rust documentation |
39-
| :---------------------: | :---------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------: |
40-
| **Mithril client WASM** | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/tree/main/mithril-client-wasm) | [:arrow_upper_right:](https://mithril.network/rust-doc/mithril_client_wasm/index.html) |
37+
| Node | Source repository | Rust documentation | Network configurations |
38+
| :---------------------: | :---------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------: | :--------------------------------------------------------------------: |
39+
| **Mithril client WASM** | [:arrow_upper_right:](https://github.com/input-output-hk/mithril/tree/main/mithril-client-wasm) | [:arrow_upper_right:](https://mithril.network/rust-doc/mithril_client_wasm/index.html) | [:arrow_upper_right:](../../getting-started/network-configurations.md) |
4140

4241
## Installation
4342

@@ -224,7 +223,7 @@ You can verify that the aggregator signs **CardanoStakeDistribution** by running
224223
wget -q -O - YOUR_AGGREGATOR_ENDPOINT | jq '.capabilities.signed_entity_types | contains(["CardanoStakeDistribution"])'
225224
```
226225

227-
For example with the aggregator on `testing-preview` Mithril network:
226+
For example, with the aggregator on the `testing-preview` Mithril network:
228227

229228
```bash
230229
wget -q -O - https://aggregator.testing-preview.api.mithril.network/aggregator | jq '.capabilities.signed_entity_types | contains(["CardanoStakeDistribution"])'

0 commit comments

Comments
 (0)