From 5e7b04d3fde55eb72f9c523897cdc6f11e2f153d Mon Sep 17 00:00:00 2001 From: Marcos Antonio Maceo Reyes Date: Tue, 15 Aug 2023 17:12:21 +0400 Subject: [PATCH] [docs] minor changes --- docs/01-getting-started/installing-nethermind.md | 1 + .../manage-nethermind-with-systemd.md | 4 ++++ docs/01-getting-started/migrating-from-geth.md | 12 ++++++++---- docs/01-getting-started/networks.md | 1 + docs/01-getting-started/system-requirements.md | 1 + .../01-running-nethermind/_category_.json | 8 ++++++++ .../02-fundamentals/04-configuration/_category_.json | 8 ++++++++ .../06-logs}/_category_.json | 4 ++-- .../08-how-to-reduce-database-size/_category_.json | 8 ++++++++ .../09-private-networks/_category_.json | 11 +++++++++++ ...-merge.md => 10-running-nethermind-post-merge.md} | 0 .../02-json-rpc-api/admin.md | 2 +- .../02-json-rpc-api/clique.md | 2 +- .../02-json-rpc-api/debug.md | 2 +- .../02-json-rpc-api/engine-jsonrpc-config-example.md | 4 ++++ .../02-json-rpc-api/eth.md | 2 +- .../02-json-rpc-api/evm.md | 2 +- .../02-json-rpc-api/{net.mdx => net.md} | 2 +- .../02-json-rpc-api/parity.md | 2 +- .../02-json-rpc-api/personal.md | 2 +- .../02-json-rpc-api/proof.md | 2 +- .../02-json-rpc-api/rpc.md | 2 +- .../02-json-rpc-api/trace.md | 2 +- .../02-json-rpc-api/txpool.md | 2 +- .../02-json-rpc-api/web3.md | 2 +- .../02-json-rpc-api/witness.md | 2 +- .../deploy-nethermind-with-monitoring-stack.md | 11 +++++------ .../metrics-explanation/_category_.json | 11 +++++++++++ docs/04-monitoring/monitoring-node-health.md | 7 ++++++- docs/06-nethermind-utilities/_category_.json | 3 --- docs/07-resources/connecting-wallet.md | 4 ++++ docs/07-resources/faq.md | 5 +++++ docs/07-resources/firewall-configuration.md | 1 + docs/07-resources/guides-and-helpers/_category_.json | 8 ++++++++ ...2-lighthouse-less-than-greater-than-nethermind.md | 4 ++-- .../validator-setup/eth2-validator.md | 4 ++-- docs/07-resources/know-issues.md | 1 + docs/{08-contact/README.md => Contact.md} | 1 + 38 files changed, 116 insertions(+), 34 deletions(-) create mode 100644 docs/02-fundamentals/01-running-nethermind/_category_.json create mode 100644 docs/02-fundamentals/04-configuration/_category_.json rename docs/{08-contact => 02-fundamentals/06-logs}/_category_.json (81%) create mode 100644 docs/02-fundamentals/08-how-to-reduce-database-size/_category_.json create mode 100644 docs/02-fundamentals/09-private-networks/_category_.json rename docs/02-fundamentals/{running-nethermind-post-merge.md => 10-running-nethermind-post-merge.md} (100%) rename docs/03-interacting-with-nethermind/02-json-rpc-api/{net.mdx => net.md} (99%) rename docs/{07-resources/guides-and-helpers => 04-monitoring}/deploy-nethermind-with-monitoring-stack.md (91%) create mode 100644 docs/04-monitoring/metrics-explanation/_category_.json create mode 100644 docs/07-resources/guides-and-helpers/_category_.json rename docs/{08-contact/README.md => Contact.md} (98%) diff --git a/docs/01-getting-started/installing-nethermind.md b/docs/01-getting-started/installing-nethermind.md index f92a42053..93c0e9772 100644 --- a/docs/01-getting-started/installing-nethermind.md +++ b/docs/01-getting-started/installing-nethermind.md @@ -1,6 +1,7 @@ --- title: Installing Nethermind sidebar_label: Installing Nethermind +sidebar_position: 0 --- import Tabs from "@theme/Tabs"; diff --git a/docs/01-getting-started/manage-nethermind-with-systemd.md b/docs/01-getting-started/manage-nethermind-with-systemd.md index 11adc39db..5be622fb1 100644 --- a/docs/01-getting-started/manage-nethermind-with-systemd.md +++ b/docs/01-getting-started/manage-nethermind-with-systemd.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 5 +--- + # Manage Nethermind with systemd ### Create a new user diff --git a/docs/01-getting-started/migrating-from-geth.md b/docs/01-getting-started/migrating-from-geth.md index 6183469e4..64806fd5c 100644 --- a/docs/01-getting-started/migrating-from-geth.md +++ b/docs/01-getting-started/migrating-from-geth.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 4 +--- + # Migrating From Geth To migrate from Geth to Nethermind there are few conditions which should be met to ensure seamless and quick transition. @@ -32,7 +36,7 @@ to [#option-1b-use-sedge-to-install-nethermind-next-to-geth-quickly](migrating-f #### Step 2 - Run secondary CL client for Nethermind syncing purpose only Please refer to -a [#step-2-installing-consensus-client](../02-fundamentals/running-nethermind-post-merge.md#step-2-installing-consensus-client) +a [#step-2-installing-consensus-client](../02-fundamentals/10-running-nethermind-post-merge.md#step-2-installing-consensus-client) to install secondary CL client beacon node which will be used only for Nethermind syncing purpose.\ Once it is installed ensure it is not colliding with primary CL currently used by Geth. @@ -52,7 +56,7 @@ NETHERMIND\_ENGINE\_PORT should be changed to value selected in next step (prefe #### Step 3 - Run Nethermind and wait for Sync -Please refer to a [#step-4-run-nethermind](../02-fundamentals/running-nethermind-post-merge.md#step-4-run-nethermind)for +Please refer to a [#step-4-run-nethermind](../02-fundamentals/10-running-nethermind-post-merge.md#step-4-run-nethermind)for instruction on how to run Nethermind. :::caution @@ -161,7 +165,7 @@ it may cause some unexpected problems during procedure of syncing Nethermind. #### Step 2 - Download Nethermind latest release Please refer to -a [#step-1-installing-nethermind](../02-fundamentals/running-nethermind-post-merge.md#step-1-installing-nethermind) to see +a [#step-1-installing-nethermind](../02-fundamentals/10-running-nethermind-post-merge.md#step-1-installing-nethermind) to see available options or use [**Sedge** ](https://docs.sedge.nethermind.io/) which is a one-click setup tool for running node developed by Nethermind Team. @@ -176,7 +180,7 @@ to Nethermind jwtsecret or point Nethermind to that jwtsecret using command:\ Nethermind will generate jwtsecret in `keystore` directory and if not specified, it will use this secret. After reconfiguring CL, run Nethermind an monitor it. Please refer to -a [#step-4-run-nethermind](../02-fundamentals/running-nethermind-post-merge.md#step-5-run-nethermind)for instruction on how to +a [#step-4-run-nethermind](../02-fundamentals/10-running-nethermind-post-merge.md#step-5-run-nethermind)for instruction on how to run Nethermind. Now Nethermind node should be syncing well using CL reconfigured on machine. To monitor status of syncing there is a diff --git a/docs/01-getting-started/networks.md b/docs/01-getting-started/networks.md index fc1fe255b..fbc1286e8 100644 --- a/docs/01-getting-started/networks.md +++ b/docs/01-getting-started/networks.md @@ -1,5 +1,6 @@ --- description: Networks currently supported by Nethermind Client +sidebar_position: 3 --- # Networks diff --git a/docs/01-getting-started/system-requirements.md b/docs/01-getting-started/system-requirements.md index 327ee2559..b9f9b2611 100644 --- a/docs/01-getting-started/system-requirements.md +++ b/docs/01-getting-started/system-requirements.md @@ -1,5 +1,6 @@ --- description: Run Nethermind on a platform of your choice +sidebar_position: 2 --- # System Requirements diff --git a/docs/02-fundamentals/01-running-nethermind/_category_.json b/docs/02-fundamentals/01-running-nethermind/_category_.json new file mode 100644 index 000000000..f98bee3f1 --- /dev/null +++ b/docs/02-fundamentals/01-running-nethermind/_category_.json @@ -0,0 +1,8 @@ +{ + "position": 1, + "label": "Running Nethermind", + "collapsible": true, + "link": { + "type": "generated-index" + } +} diff --git a/docs/02-fundamentals/04-configuration/_category_.json b/docs/02-fundamentals/04-configuration/_category_.json new file mode 100644 index 000000000..ee1531c9d --- /dev/null +++ b/docs/02-fundamentals/04-configuration/_category_.json @@ -0,0 +1,8 @@ +{ + "position": 4, + "label": "Configuration", + "collapsible": true, + "link": { + "type": "generated-index" + } +} diff --git a/docs/08-contact/_category_.json b/docs/02-fundamentals/06-logs/_category_.json similarity index 81% rename from docs/08-contact/_category_.json rename to docs/02-fundamentals/06-logs/_category_.json index aed12760e..e394f221f 100644 --- a/docs/08-contact/_category_.json +++ b/docs/02-fundamentals/06-logs/_category_.json @@ -1,6 +1,6 @@ { - "position": 8, - "label": "Contact Us", + "position": 6, + "label": "Logs", "collapsible": true, "link": { "type": "generated-index" diff --git a/docs/02-fundamentals/08-how-to-reduce-database-size/_category_.json b/docs/02-fundamentals/08-how-to-reduce-database-size/_category_.json new file mode 100644 index 000000000..5d77e2aad --- /dev/null +++ b/docs/02-fundamentals/08-how-to-reduce-database-size/_category_.json @@ -0,0 +1,8 @@ +{ + "position": 8, + "label": "How to reduce the size of the database", + "collapsible": true, + "link": { + "type": "generated-index" + } +} diff --git a/docs/02-fundamentals/09-private-networks/_category_.json b/docs/02-fundamentals/09-private-networks/_category_.json new file mode 100644 index 000000000..6deb9a9c6 --- /dev/null +++ b/docs/02-fundamentals/09-private-networks/_category_.json @@ -0,0 +1,11 @@ +{ + "position": 2, + "label": "Fundamentals", + "collapsible": true, + "link": { + "type": "generated-index" + }, + "customProps": { + "description": "General overview and introduction of Nethermind Execution Client" + } +} diff --git a/docs/02-fundamentals/running-nethermind-post-merge.md b/docs/02-fundamentals/10-running-nethermind-post-merge.md similarity index 100% rename from docs/02-fundamentals/running-nethermind-post-merge.md rename to docs/02-fundamentals/10-running-nethermind-post-merge.md diff --git a/docs/03-interacting-with-nethermind/02-json-rpc-api/admin.md b/docs/03-interacting-with-nethermind/02-json-rpc-api/admin.md index 9e6ca41c7..94b32475f 100644 --- a/docs/03-interacting-with-nethermind/02-json-rpc-api/admin.md +++ b/docs/03-interacting-with-nethermind/02-json-rpc-api/admin.md @@ -1,7 +1,7 @@ import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; -# admin +# Admin ## admin_addPeer diff --git a/docs/03-interacting-with-nethermind/02-json-rpc-api/clique.md b/docs/03-interacting-with-nethermind/02-json-rpc-api/clique.md index e12373ba0..0f2ddedde 100644 --- a/docs/03-interacting-with-nethermind/02-json-rpc-api/clique.md +++ b/docs/03-interacting-with-nethermind/02-json-rpc-api/clique.md @@ -1,7 +1,7 @@ import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; -# clique +# Clique ## clique_discard diff --git a/docs/03-interacting-with-nethermind/02-json-rpc-api/debug.md b/docs/03-interacting-with-nethermind/02-json-rpc-api/debug.md index 0d058471f..4960d0728 100644 --- a/docs/03-interacting-with-nethermind/02-json-rpc-api/debug.md +++ b/docs/03-interacting-with-nethermind/02-json-rpc-api/debug.md @@ -1,7 +1,7 @@ import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; -# debug +# Debug ## debug_deleteChainSlice diff --git a/docs/03-interacting-with-nethermind/02-json-rpc-api/engine-jsonrpc-config-example.md b/docs/03-interacting-with-nethermind/02-json-rpc-api/engine-jsonrpc-config-example.md index 8f9c6f399..530f0286e 100644 --- a/docs/03-interacting-with-nethermind/02-json-rpc-api/engine-jsonrpc-config-example.md +++ b/docs/03-interacting-with-nethermind/02-json-rpc-api/engine-jsonrpc-config-example.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 0 +--- + import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; diff --git a/docs/03-interacting-with-nethermind/02-json-rpc-api/eth.md b/docs/03-interacting-with-nethermind/02-json-rpc-api/eth.md index f53930945..eb2ef3ebd 100644 --- a/docs/03-interacting-with-nethermind/02-json-rpc-api/eth.md +++ b/docs/03-interacting-with-nethermind/02-json-rpc-api/eth.md @@ -1,7 +1,7 @@ import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; -# eth +# Eth ## eth_blockNumber diff --git a/docs/03-interacting-with-nethermind/02-json-rpc-api/evm.md b/docs/03-interacting-with-nethermind/02-json-rpc-api/evm.md index 4a3416134..52442c5b1 100644 --- a/docs/03-interacting-with-nethermind/02-json-rpc-api/evm.md +++ b/docs/03-interacting-with-nethermind/02-json-rpc-api/evm.md @@ -1,4 +1,4 @@ -# evm +# Evm ## evm_mine diff --git a/docs/03-interacting-with-nethermind/02-json-rpc-api/net.mdx b/docs/03-interacting-with-nethermind/02-json-rpc-api/net.md similarity index 99% rename from docs/03-interacting-with-nethermind/02-json-rpc-api/net.mdx rename to docs/03-interacting-with-nethermind/02-json-rpc-api/net.md index 69dfa2ef0..8acdf132c 100644 --- a/docs/03-interacting-with-nethermind/02-json-rpc-api/net.mdx +++ b/docs/03-interacting-with-nethermind/02-json-rpc-api/net.md @@ -1,7 +1,7 @@ import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; -# net +# Net ## net_listening diff --git a/docs/03-interacting-with-nethermind/02-json-rpc-api/parity.md b/docs/03-interacting-with-nethermind/02-json-rpc-api/parity.md index 1953fc607..b9611bd4b 100644 --- a/docs/03-interacting-with-nethermind/02-json-rpc-api/parity.md +++ b/docs/03-interacting-with-nethermind/02-json-rpc-api/parity.md @@ -1,7 +1,7 @@ import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; -# parity +# Parity ## parity_clearEngineSigner diff --git a/docs/03-interacting-with-nethermind/02-json-rpc-api/personal.md b/docs/03-interacting-with-nethermind/02-json-rpc-api/personal.md index 00a80833d..95556007b 100644 --- a/docs/03-interacting-with-nethermind/02-json-rpc-api/personal.md +++ b/docs/03-interacting-with-nethermind/02-json-rpc-api/personal.md @@ -1,7 +1,7 @@ import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; -# personal +# Personal ## personal_importRawKey | Invocation | diff --git a/docs/03-interacting-with-nethermind/02-json-rpc-api/proof.md b/docs/03-interacting-with-nethermind/02-json-rpc-api/proof.md index d1c8c43a8..e8c3bd2df 100644 --- a/docs/03-interacting-with-nethermind/02-json-rpc-api/proof.md +++ b/docs/03-interacting-with-nethermind/02-json-rpc-api/proof.md @@ -1,7 +1,7 @@ import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; -# proof +# Proof ## proof_getTransactionByHash diff --git a/docs/03-interacting-with-nethermind/02-json-rpc-api/rpc.md b/docs/03-interacting-with-nethermind/02-json-rpc-api/rpc.md index 0c95b84ae..093d6da07 100644 --- a/docs/03-interacting-with-nethermind/02-json-rpc-api/rpc.md +++ b/docs/03-interacting-with-nethermind/02-json-rpc-api/rpc.md @@ -1,4 +1,4 @@ -# rpc +# RPC ## rpc_modules diff --git a/docs/03-interacting-with-nethermind/02-json-rpc-api/trace.md b/docs/03-interacting-with-nethermind/02-json-rpc-api/trace.md index e1fd511a6..f84ccd461 100644 --- a/docs/03-interacting-with-nethermind/02-json-rpc-api/trace.md +++ b/docs/03-interacting-with-nethermind/02-json-rpc-api/trace.md @@ -1,7 +1,7 @@ import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; -# trace +# Trace ## trace_block diff --git a/docs/03-interacting-with-nethermind/02-json-rpc-api/txpool.md b/docs/03-interacting-with-nethermind/02-json-rpc-api/txpool.md index 4924eeb97..aeab35274 100644 --- a/docs/03-interacting-with-nethermind/02-json-rpc-api/txpool.md +++ b/docs/03-interacting-with-nethermind/02-json-rpc-api/txpool.md @@ -1,7 +1,7 @@ import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; -# txpool +# Txpool ## txpool_content diff --git a/docs/03-interacting-with-nethermind/02-json-rpc-api/web3.md b/docs/03-interacting-with-nethermind/02-json-rpc-api/web3.md index fd641060b..ce85c7676 100644 --- a/docs/03-interacting-with-nethermind/02-json-rpc-api/web3.md +++ b/docs/03-interacting-with-nethermind/02-json-rpc-api/web3.md @@ -1,7 +1,7 @@ import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; -# web3 +# Web3 ## web3_clientVersion diff --git a/docs/03-interacting-with-nethermind/02-json-rpc-api/witness.md b/docs/03-interacting-with-nethermind/02-json-rpc-api/witness.md index abf22df27..7c8a1d1cf 100644 --- a/docs/03-interacting-with-nethermind/02-json-rpc-api/witness.md +++ b/docs/03-interacting-with-nethermind/02-json-rpc-api/witness.md @@ -1,7 +1,7 @@ import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; -# witness +# Witness ## witness_witnesses diff --git a/docs/07-resources/guides-and-helpers/deploy-nethermind-with-monitoring-stack.md b/docs/04-monitoring/deploy-nethermind-with-monitoring-stack.md similarity index 91% rename from docs/07-resources/guides-and-helpers/deploy-nethermind-with-monitoring-stack.md rename to docs/04-monitoring/deploy-nethermind-with-monitoring-stack.md index e8da7b416..cfee42baa 100644 --- a/docs/07-resources/guides-and-helpers/deploy-nethermind-with-monitoring-stack.md +++ b/docs/04-monitoring/deploy-nethermind-with-monitoring-stack.md @@ -1,7 +1,6 @@ --- -description: >- - Recipe for a fast and easy terraform deployment of Nethermind Client and - Monitoring stack (Grafana/Prometheus/Seq) +sidebar_label: Deploy Nethermind with Monitoring stack +sidebar_position: 2 --- # Deploy Nethermind with Monitoring stack @@ -115,11 +114,11 @@ You can now provide some basic configuration to your VM/Nethermind Node ![]() -A list of available `configs` can be found [here](../../01-getting-started/networks.md) +A list of available `configs` can be found [here](../01-getting-started/networks.md) :::caution :fire\_extinguisher: If you chose to enable JsonRpc (it will run on port `8545` by default) make sure that you set -up [Firewall rules](../firewall-configuration.md) either in DigitalOcean or by using Linux `iptables` +up [Firewall rules](../07-resources/firewall-configuration.md) either in DigitalOcean or by using Linux `iptables` ::: Let's apply our plan and start deploying whole stack (it should take no longer than 3 minutes) @@ -162,7 +161,7 @@ Explore Nethermind metrics, visualize and analyse using prometheus syntax, a lis descriptions can be found here: {% content-ref url="../ethereum-client/metrics/" %} -[metrics](../../04-monitoring/metrics-explanation/README.md) +[metrics](metrics-explanation/README.md) {% endcontent-ref %} ![]() diff --git a/docs/04-monitoring/metrics-explanation/_category_.json b/docs/04-monitoring/metrics-explanation/_category_.json new file mode 100644 index 000000000..eacb9dbc9 --- /dev/null +++ b/docs/04-monitoring/metrics-explanation/_category_.json @@ -0,0 +1,11 @@ +{ + "position": 0, + "label": "Metrics", + "collapsible": true, + "link": { + "type": "generated-index" + }, + "customProps": { + "description": "General overview and introduction of Nethermind Execution Client" + } +} diff --git a/docs/04-monitoring/monitoring-node-health.md b/docs/04-monitoring/monitoring-node-health.md index e20e4836a..10f413f86 100644 --- a/docs/04-monitoring/monitoring-node-health.md +++ b/docs/04-monitoring/monitoring-node-health.md @@ -1,3 +1,8 @@ +--- +sidebar_position: 1 +sidebar_label: Monitoring Node's Health +--- + import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; @@ -98,7 +103,7 @@ When it becomes **Healthy** (**synced** and with **peers**) you should receive: 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 -CL [here](../02-fundamentals/running-nethermind-post-merge.md). +CL [here](../02-fundamentals/10-running-nethermind-post-merge.md). ``` No incoming messages from Consensus Client. Consensus Client is required to sync the node. Please make sure that it's working properly. diff --git a/docs/06-nethermind-utilities/_category_.json b/docs/06-nethermind-utilities/_category_.json index 6ad2367a0..fcb58829a 100644 --- a/docs/06-nethermind-utilities/_category_.json +++ b/docs/06-nethermind-utilities/_category_.json @@ -4,8 +4,5 @@ "collapsible": true, "link": { "type": "generated-index" - }, - "customProps": { - "description": "General overview and introduction of Nethermind Execution Client" } } diff --git a/docs/07-resources/connecting-wallet.md b/docs/07-resources/connecting-wallet.md index d938b1a41..32d29bd76 100644 --- a/docs/07-resources/connecting-wallet.md +++ b/docs/07-resources/connecting-wallet.md @@ -1,3 +1,7 @@ +--- +sidebar_position: 1 +--- + # Connecting Wallet You can connect to the node from [Metamask](https://metamask.io/) by selecting `localhost:8545` from the Metamask network list. diff --git a/docs/07-resources/faq.md b/docs/07-resources/faq.md index 71aa3b45a..5b0e72745 100644 --- a/docs/07-resources/faq.md +++ b/docs/07-resources/faq.md @@ -1,3 +1,8 @@ +--- +sidebar_position: 0 +sidebar_label: Frequently Asked Questions +--- + # FAQ ## How do I upgrade my node? diff --git a/docs/07-resources/firewall-configuration.md b/docs/07-resources/firewall-configuration.md index 7bc2bceb2..338579e9a 100644 --- a/docs/07-resources/firewall-configuration.md +++ b/docs/07-resources/firewall-configuration.md @@ -1,5 +1,6 @@ --- description: Rules that should be added to your machine's firewall +sidebar_position: 2 --- # Firewall Configuration diff --git a/docs/07-resources/guides-and-helpers/_category_.json b/docs/07-resources/guides-and-helpers/_category_.json new file mode 100644 index 000000000..f31da4ea7 --- /dev/null +++ b/docs/07-resources/guides-and-helpers/_category_.json @@ -0,0 +1,8 @@ +{ + "position": 0, + "label": "Guides and Helpers", + "collapsible": true, + "link": { + "type": "generated-index" + } +} diff --git a/docs/07-resources/guides-and-helpers/eth2-lighthouse-less-than-greater-than-nethermind.md b/docs/07-resources/guides-and-helpers/eth2-lighthouse-less-than-greater-than-nethermind.md index f7450264f..5902a53ec 100644 --- a/docs/07-resources/guides-and-helpers/eth2-lighthouse-less-than-greater-than-nethermind.md +++ b/docs/07-resources/guides-and-helpers/eth2-lighthouse-less-than-greater-than-nethermind.md @@ -1,8 +1,8 @@ --- -description: How to run Nethermind as your ETH1 endpoint for ETH2 clients +sidebar_label: Eth2 <-> Nethermind --- -# ETH2 <-> Nethermind +# ETH2 <-> Nethermind ## Nethermind client as ETH1 endpoint diff --git a/docs/07-resources/guides-and-helpers/validator-setup/eth2-validator.md b/docs/07-resources/guides-and-helpers/validator-setup/eth2-validator.md index d72a58e27..c2c644f1c 100644 --- a/docs/07-resources/guides-and-helpers/validator-setup/eth2-validator.md +++ b/docs/07-resources/guides-and-helpers/validator-setup/eth2-validator.md @@ -61,7 +61,7 @@ Run the following command to install Nethermind: sudo add-apt-repository ppa:nethermindeth/nethermind; sudo apt install nethermind ``` -See [here](../../../02-fundamentals/running-nethermind-post-merge.md) for docs for +See [here](../../../02-fundamentals/10-running-nethermind-post-merge.md) for docs for other ways to install Nethermind. #### **Installing Consensus Client** @@ -140,7 +140,7 @@ sudo chown -R nethermindeth:nethermindeth /usr/share/nethermind Create a JWT Token which will be used to communicate between consensus and execution clients. For more information about JWT Token please refer -to [this section](../../../02-fundamentals/running-nethermind-post-merge.md#step-3--configure-json-rpc-api). +to [this section](../../../02-fundamentals/10-running-nethermind-post-merge.md#step-3--configure-json-rpc-api). ```bash openssl rand -hex 32 | tr -d "\n" > "/var/lib/nethermind/jwt-secret" diff --git a/docs/07-resources/know-issues.md b/docs/07-resources/know-issues.md index b566fb81c..9e19f13ad 100644 --- a/docs/07-resources/know-issues.md +++ b/docs/07-resources/know-issues.md @@ -1,5 +1,6 @@ --- description: There are several known issues with the current version of Nethermind +sidebar_position: 3 --- # Known Issues diff --git a/docs/08-contact/README.md b/docs/Contact.md similarity index 98% rename from docs/08-contact/README.md rename to docs/Contact.md index fc20e441f..8247b4333 100644 --- a/docs/08-contact/README.md +++ b/docs/Contact.md @@ -1,5 +1,6 @@ --- sidebar_label: 'Contact Us' +sidebar_position: 8 --- # Contact us