Migrate to Docusaurus v3

NethermindEth · Nov 1, 2023 · 7cdbc7c · 7cdbc7c
1 parent 33835a4
commit 7cdbc7c
Show file tree

Hide file tree

Showing 34 changed files with 5,092 additions and 13,775 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
diff --git a/docs/fundamentals/configuration.md b/docs/fundamentals/configuration.md
@@ -24,7 +24,7 @@ nethermind -h
 
 Below is the list of the basic options followed by an exhaustive list of options by namespace.
 
-:::caution
+:::warning
 The command line options are case-sensitive and can be defined only once unless stated otherwise.
 :::
 
@@ -64,7 +64,7 @@ The command line options are case-sensitive and can be defined only once unless
 
   An absolute or relative path to the Nethermind data directory. Defaults to Nethermind's current directory.
 
-  :::caution
+  :::warning
   The absolute paths set by `Init.BaseDbPath`, `Init.LogDirectory`, or `KeyStore.KeyStoreDirectory` options in a configuration file are not overridden by `--datadir`.
   :::
 

diff --git a/docs/fundamentals/private-networks.md b/docs/fundamentals/private-networks.md
@@ -60,7 +60,7 @@ Kurtosis will use the `ethereum-package` environment definition and your custom
 
 Here is a sample output:
 
-```console
+```
 INFO[2023-09-01T16:10:45-04:00] ====================================================
 INFO[2023-09-01T16:10:45-04:00] ||          Created enclave: timid-knoll          ||
 INFO[2023-09-01T16:10:45-04:00] ====================================================

diff --git a/docs/fundamentals/pruning.md b/docs/fundamentals/pruning.md
@@ -85,7 +85,7 @@ trigger [#admin\_prune](../interacting/json-rpc-ns/admin.md#admin_prune) command
 Pruning should
 be started.
 
-:::caution
+:::warning
 One potential disadvantage of Manual mode is that if Full Pruning is not triggered in time (due to insufficient disk
 space), it cannot be executed. In such cases, the only option to free up disk space would be to resync the node from
 scratch.

diff --git a/docs/fundamentals/security.md b/docs/fundamentals/security.md
@@ -17,7 +17,7 @@ sidebar_position: 3
 :loudspeaker:The private key from which the node ID is derived is stored on disk (**NOT** protected by password).
 :::
 
-:::caution
+:::warning
 Nethermind is thoroughly tested but the more popular it will get the more likely it will be the target of client-specific attacks. Generally you should always consider running backup client nodes implemented by a different team for any critical operations.
 :::
 

diff --git a/docs/get-started/consensus-clients.md b/docs/get-started/consensus-clients.md
@@ -20,7 +20,7 @@ On the consensus layer, there are 5 client implementations to choose from. Thoug
 - [Prysm][prysm]
 - [Teku][teku]
 
-:::caution Important
+:::warning Important
 We urge you to take [client diversity](https://ethereum.org/en/developers/docs/nodes-and-clients/client-diversity) into consideration when choosing your consensus client and avoid the majority clients.
 :::
 
@@ -108,7 +108,7 @@ The command above runs Teku on Mainnet. For other networks, set the `--network`
 
 ## Running Nethermind
 
-:::caution Important
+:::warning Important
 The consensus client must be running before you start Nethermind.
 :::
 

diff --git a/docs/get-started/installing-nethermind.md b/docs/get-started/installing-nethermind.md
@@ -256,7 +256,7 @@ To build the Docker image yourself, see [Building Docker image](../developers/bu
 
 ## Running Nethermind {#running}
 
-:::caution Important
+:::warning Important
 A [consensus client](consensus-clients.md) of your choice must be running before you start Nethermind.
 :::
 

diff --git a/docs/get-started/migrating-from-geth.md b/docs/get-started/migrating-from-geth.md
@@ -46,7 +46,7 @@ second instance of Prysm, flags needed to be used are (considering that primary
 `--rpc-port=4001 --p2p-tcp-port=13001 --p2p-udp-port=12001 --grpc-gateway-port=3501`
 :::
 
-:::caution
+:::warning
 **REMEMBER**\
 Nethermind node will also be running on separate ports so there should be
 a `--execution-endpoint=http://localhost:<<NETHERMIND_ENGINE_PORT>>` flag set keeping in mind that
@@ -58,7 +58,7 @@ NETHERMIND\_ENGINE\_PORT should be changed to value selected in next step (prefe
 Please refer to a [#step-4-run-nethermind](consensus-clients.md)for
 instruction on how to run Nethermind.
 
-:::caution
+:::warning
 **REMEMBER**
 
 For Nethermind You will also need to set a separate ports to not create a conflict with still working Geth node. Values

diff --git a/docs/interacting/json-rpc-server.md b/docs/interacting/json-rpc-server.md
@@ -39,7 +39,7 @@ The Engine API is a set of RPC methods that enable communication between an exec
 
 By default, the Engine API uses local loopback (`127.0.0.1` or `localhost`) and `8551` port. To use a different host or port, set the `--JsonRpc.EngineHost` and `--JsonRpc.EnginePort` command line options, respectively. For example, this can be useful when execution and consensus clients are on different machines.
 
-:::caution Important
+:::warning Important
 When the `--JsonRpc.EngineHost` option is specified, the `--JsonRpc.EnginePort` option must be specified as well.
 :::
 

diff --git a/docs/monitoring/health-check.md b/docs/monitoring/health-check.md
@@ -84,8 +84,9 @@ We may also add Slack Webhook endpoint to which our node's health will be report
 the `--HealthChecks.WebhooksEnabled true` and add the `--HealthChecks.WebhooksUri` which can be found in your Slack app
 configuration.
 
-<pre class="language-bash"><code class="lang-bash"><strong>./Nethermind.Runner --HealthChecks.Enabled true --HealthChecks.UIEnabled true --HealthChecks.WebhooksEnabled true --HealthChecks.WebhooksUri https://hooks.slack.com/
-</strong></code></pre>
+```bash
+nethermind --HealthChecks.Enabled true --HealthChecks.UIEnabled true --HealthChecks.WebhooksEnabled true --HealthChecks.WebhooksUri https://hooks.slack.com/
+```
 
 If your node will be **Unhealthy** you should receive a message similar to this:
 
@@ -100,14 +101,14 @@ When it becomes **Healthy** (**synced** and with **peers**) you should receive:
 #### Consensus Client health
 
 This check verifies if the client receives messages from the CL. If you see this warning in your logs, it means that
-there is something wrong with CL<->Nethermind communication. Check more about setting up Nethermind and
+there is something wrong with CL/Nethermind communication. Check more about setting up Nethermind and
 CL [here](../get-started/consensus-clients.md).
 
 ```
 No incoming messages from Consensus Client. Consensus Client is required to sync the node. Please make sure that it's working properly.
 ```
 
-:::caution
+:::warning
 Note that Consensus Client is required for normal node operations.
 :::
 
@@ -162,8 +163,9 @@ configure database location. There are two new configuration options available:
 * `--HealthChecks.LowStorageSpaceShutdownThreshold` - Percentage of available disk space below which node will shutdown
   to avoid database corruption. Default value is 1 - meaning 1% of free disk space.
 
-<pre><code><strong>./Nethermind.Runner --HealthChecks.LowStorageSpaceWarningThreshold 5 --HealthChecks.LowStorageSpaceShutdownThreshold 1
-</strong></code></pre>
+```bash
+nethermind --HealthChecks.LowStorageSpaceWarningThreshold 5 --HealthChecks.LowStorageSpaceShutdownThreshold 1
+```
 
 #### HealthChecks for producing and processing blocks
 

diff --git a/docs/resources/guides-and-helpers/eth2-less-than-greater-than-nethermind.md b/docs/resources/guides-and-helpers/eth2-less-than-greater-than-nethermind.md
diff --git a/...sources/guides-and-helpers/eth2-lighthouse-less-than-greater-than-nethermind.md b/...sources/guides-and-helpers/eth2-lighthouse-less-than-greater-than-nethermind.md
@@ -2,16 +2,16 @@
 sidebar_label: Eth2 <-> Nethermind 
 ---
 
-# ETH2 <-> Nethermind
+# ETH2 \<-\> Nethermind
 
 ## Nethermind client as ETH1 endpoint
 
-:::caution
+:::warning
 You should always consider being able to switch to Infura or another provider as a backup for safety \(or run two nodes
 yourself\)👈
 :::
 
-:::caution
+:::warning
 For a more comprehensive step-by-step guide, you should look into one of these awesome guides
 -&gt; [https://someresat.medium.com/](https://someresat.medium.com/). Below you will find instructions on how to run
 Nethermind node -&gt; **Step 6 — Set up an Ethereum \(Eth1\) Node**
@@ -23,7 +23,7 @@ Nethermind node -&gt; **Step 6 — Set up an Ethereum \(Eth1\) Node**
 
 You can get it either from [Github Releases or our Downloads page](../../get-started/installing-nethermind.md#downloading-releases)
 
-{% page-ref page="../ethereum-client/download-sources/" %}
+
 
 * [x] unzip the package
 * [x] run the Nethermind node \(use `Nethermind.Launcher` or change `configs/mainnet.cfg` and

diff --git a/docs/resources/known-issues.md b/docs/resources/known-issues.md
@@ -104,7 +104,7 @@ how much new state there is to be downloaded.
 
 ## Main issues reported so far when using Nethermind for Eth2 (30.11.2020)
 
-:::caution
+:::warning
 
 * users who synced before version **1.9.41** and were not aware that old configs were **not** supporting Eth2 by default
   had to resync with **1.9.41** (and they are reporting successful setups now)&#x20;

diff --git a/docs/utilities/cli/README.md b/docs/utilities/cli/README.md
@@ -9,7 +9,7 @@ After launching `./Nethermind.Launcher` you have two options - `Ethereum Node` a
 If you launch the Node in one process and then launch the CLI in another process you will see available commands inside
 the CLI.
 
-:::caution
+:::warning
 You have to ensure that the `JsonRpc.Enabled` is set to `true` either by enabling it when Launcher asks about it or by
 manually editing the relevant config file or by passing `--JsonRpc.Enabled true` parameter after the Launcher command
 :::

diff --git a/docs/utilities/cli/eth.md b/docs/utilities/cli/eth.md
@@ -1711,7 +1711,7 @@ eth.pendingTransactions
 </TabItem>
 <TabItem value="objects" label="Object">
 
-{% tab title="Objects in eth_pendingTransactions" %}
+
 
 `TransactionForRpc`