Move Fundamentals

NethermindEth · Aug 17, 2023 · 6691346 · 6691346
1 parent 9dcea81
commit 6691346
Show file tree

Hide file tree

Showing 56 changed files with 22 additions and 25 deletions.
diff --git a/docs/04-monitoring/metrics-explanation/setting-up-local-metrics-infrastracture.md b/docs/04-monitoring/metrics-explanation/setting-up-local-metrics-infrastracture.md
@@ -6,7 +6,7 @@ import TabItem from "@theme/TabItem";
 ## Metrics Configuration
 
 Nethermind metrics can be consumed by _Prometheus/Grafana_ if configured
-in [Metrics configuration category](../../02-fundamentals/04-configuration/metrics.md).
+in [Metrics configuration category](../../fundamentals/04-configuration/metrics.md).
 
 ## Metrics infrastructure
 

diff --git a/docs/04-monitoring/monitoring-node-health.md b/docs/04-monitoring/monitoring-node-health.md
@@ -37,7 +37,7 @@ a `"HealthChecks"` section to the config file.&#x20;
 JSON RPC Service needs to be enabled in order for health checks to work `--JsonRpc.Enabled true`
 :::
 
-Each configuration option is described [here](../02-fundamentals/04-configuration/healthchecks.md).
+Each configuration option is described [here](../fundamentals/04-configuration/healthchecks.md).
 
 #### Enabling Health Checks without UI&#x20;
 
@@ -103,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/10-running-nethermind-post-merge.md).
+CL [here](../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/07-resources/faq.md b/docs/07-resources/faq.md
@@ -55,17 +55,17 @@ If you have any issues, please reach out to us on Discord: [https://discord.gg/X
 
 ## Can I disable logging to file?
 
-You can find more details on the logging config page [here](../02-fundamentals/06-logs/logging-configuration.md)
+You can find more details on the logging config page [here](../fundamentals/06-logs/logging-configuration.md)
 
 ## Can I disable logging of JSON RPC calls?
 
-You can find more details on the logging config page [here](../02-fundamentals/06-logs/logging-configuration.md)
+You can find more details on the logging config page [here](../fundamentals/06-logs/logging-configuration.md)
 
 ## How can I configure validator on AuRa / Clique?
 
 You can find more details on running validators in the docs ->
 for [AuRa](./guides-and-helpers/validator-setup/aura-validator.md) and
-for [Clique](../02-fundamentals/09-private-networks/how-to-setup-a-nethermind-only-clique-based-chain.md).
+for [Clique](../fundamentals/09-private-networks/how-to-setup-a-nethermind-only-clique-based-chain.md).
 
 You can learn more about how to setup a aura validator [here](./guides-and-helpers/validator-setup/aura-validator.md)
 

diff --git a/docs/07-resources/guides-and-helpers/eth2-less-than-greater-than-nethermind.md b/docs/07-resources/guides-and-helpers/eth2-less-than-greater-than-nethermind.md
@@ -60,7 +60,7 @@ You should see the node starting:
 
 ### Running Nethermind as a systemd service
 
-You might follow [the following guide](../../get-started/manage-nethermind-with-systemd.md) to run Nethermind as
+You might follow [the following guide](../../get-started/installing-nethermind.md#confuguring-as-a-linux-service) to run Nethermind as
 a
 systemd service
 

diff --git a/docs/07-resources/guides-and-helpers/validator-setup/aura-validator.md b/docs/07-resources/guides-and-helpers/validator-setup/aura-validator.md
@@ -8,7 +8,7 @@ description: >-
 
 This article will lead you through docker-compose setup of **Nethermind Aura Validator** (xDai chain in this example).
 Same result can be obtained
-by [Downloading](../../../get-started/installing-nethermind.md) & [Running Nethermind](../../../02-fundamentals/01-running-nethermind/running-the-client.md)
+by [Downloading](../../../get-started/installing-nethermind.md) & [Running Nethermind](../../../fundamentals/01-running-nethermind/running-the-client.md)
 package or by [Building Nethermind](../../../developers/building-from-source.md) from the source code.&#x20;
 
 If you chose not to use docker-compose, you can skip docker-compose related sections and read
@@ -108,8 +108,8 @@ container (`xdai.cfg` file in above example).
 Make sure that `nethermind_db`, `keystore`(`logs` - optional ) are mapped, otherwise you might lose database or keys
 :::
 
-[`NLog.config`](../../../02-fundamentals/01-running-nethermind/runtime.md#nlog-config) file is optional.\
-[`static-nodes.json`](../../../02-fundamentals/01-running-nethermind/runtime.md#static-nodes) can be filled with an
+[`NLog.config`](../../../fundamentals/01-running-nethermind/runtime.md#nlog-config) file is optional.\
+[`static-nodes.json`](../../../fundamentals/01-running-nethermind/runtime.md#static-nodes) can be filled with an
 array
 of enodes, this is also optional.
 

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
@@ -64,7 +64,7 @@ Run the following command to install Nethermind:
 sudo add-apt-repository ppa:nethermindeth/nethermind; sudo apt install nethermind
 ```
 
-See [here](../../../02-fundamentals/10-running-nethermind-post-merge.md) for docs for
+See [here](../../../fundamentals/10-running-nethermind-post-merge.md) for docs for
 other ways to install Nethermind.
 
 #### **Installing Consensus Client**
@@ -146,7 +146,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/10-running-nethermind-post-merge.md#step-3--configure-json-rpc-api).
+to [this section](../../../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/developers/building-from-source.md b/docs/developers/building-from-source.md
@@ -53,7 +53,7 @@ configuration only.
 The build artifacts can be found in the `bin/release/net7.0` directory. By default, the logs and database directories
 are located here as well.
 
-For more info, see [Running Nethermind](../02-fundamentals/01-running-nethermind/running-the-client.md).
+For more info, see [Running Nethermind](../fundamentals/01-running-nethermind/running-the-client.md).
 
 #### Testing
 

diff --git a/...als/01-running-nethermind/_category_.json → ...als/01-running-nethermind/_category_.json b/...als/01-running-nethermind/_category_.json → ...als/01-running-nethermind/_category_.json
diff --git a/...-running-nethermind/running-the-client.md → ...-running-nethermind/running-the-client.md b/...-running-nethermind/running-the-client.md → ...-running-nethermind/running-the-client.md
diff --git a/...amentals/01-running-nethermind/runtime.md → ...amentals/01-running-nethermind/runtime.md b/...amentals/01-running-nethermind/runtime.md → ...amentals/01-running-nethermind/runtime.md
diff --git a/docs/02-fundamentals/03-sync-modes.md → docs/fundamentals/03-sync-modes.md b/docs/02-fundamentals/03-sync-modes.md → docs/fundamentals/03-sync-modes.md
diff --git a/...2-fundamentals/04-configuration/README.md → docs/fundamentals/04-configuration/README.md b/...2-fundamentals/04-configuration/README.md → docs/fundamentals/04-configuration/README.md
diff --git a/...amentals/04-configuration/_category_.json → ...amentals/04-configuration/_category_.json b/...amentals/04-configuration/_category_.json → ...amentals/04-configuration/_category_.json
diff --git a/...ls/04-configuration/accountabstraction.md → ...ls/04-configuration/accountabstraction.md b/...ls/04-configuration/accountabstraction.md → ...ls/04-configuration/accountabstraction.md
diff --git a/.../02-fundamentals/04-configuration/aura.md → docs/fundamentals/04-configuration/aura.md b/.../02-fundamentals/04-configuration/aura.md → docs/fundamentals/04-configuration/aura.md
diff --git a/...undamentals/04-configuration/auramerge.md → ...undamentals/04-configuration/auramerge.md b/...undamentals/04-configuration/auramerge.md → ...undamentals/04-configuration/auramerge.md
diff --git a/...2-fundamentals/04-configuration/blocks.md → docs/fundamentals/04-configuration/blocks.md b/...2-fundamentals/04-configuration/blocks.md → docs/fundamentals/04-configuration/blocks.md
diff --git a/...02-fundamentals/04-configuration/bloom.md → docs/fundamentals/04-configuration/bloom.md b/...02-fundamentals/04-configuration/bloom.md → docs/fundamentals/04-configuration/bloom.md
diff --git a/...fundamentals/04-configuration/ethstats.md → ...fundamentals/04-configuration/ethstats.md b/...fundamentals/04-configuration/ethstats.md → ...fundamentals/04-configuration/ethstats.md
diff --git a/...amentals/04-configuration/healthchecks.md → ...amentals/04-configuration/healthchecks.md b/...amentals/04-configuration/healthchecks.md → ...amentals/04-configuration/healthchecks.md
diff --git a/.../02-fundamentals/04-configuration/hive.md → docs/fundamentals/04-configuration/hive.md b/.../02-fundamentals/04-configuration/hive.md → docs/fundamentals/04-configuration/hive.md
diff --git a/.../02-fundamentals/04-configuration/init.md → docs/fundamentals/04-configuration/init.md b/.../02-fundamentals/04-configuration/init.md → docs/fundamentals/04-configuration/init.md
diff --git a/...-fundamentals/04-configuration/jsonrpc.md → .../fundamentals/04-configuration/jsonrpc.md b/...-fundamentals/04-configuration/jsonrpc.md → .../fundamentals/04-configuration/jsonrpc.md
diff --git a/...fundamentals/04-configuration/keystore.md → ...fundamentals/04-configuration/keystore.md b/...fundamentals/04-configuration/keystore.md → ...fundamentals/04-configuration/keystore.md
diff --git a/...02-fundamentals/04-configuration/merge.md → docs/fundamentals/04-configuration/merge.md b/...02-fundamentals/04-configuration/merge.md → docs/fundamentals/04-configuration/merge.md
diff --git a/...-fundamentals/04-configuration/metrics.md → .../fundamentals/04-configuration/metrics.md b/...-fundamentals/04-configuration/metrics.md → .../fundamentals/04-configuration/metrics.md
diff --git a/docs/02-fundamentals/04-configuration/mev.md → docs/fundamentals/04-configuration/mev.md b/docs/02-fundamentals/04-configuration/mev.md → docs/fundamentals/04-configuration/mev.md
diff --git a/...2-fundamentals/04-configuration/mining.md → docs/fundamentals/04-configuration/mining.md b/...2-fundamentals/04-configuration/mining.md → docs/fundamentals/04-configuration/mining.md
diff --git a/...-fundamentals/04-configuration/network.md → .../fundamentals/04-configuration/network.md b/...-fundamentals/04-configuration/network.md → .../fundamentals/04-configuration/network.md
diff --git a/...2-fundamentals/04-configuration/plugin.md → docs/fundamentals/04-configuration/plugin.md b/...2-fundamentals/04-configuration/plugin.md → docs/fundamentals/04-configuration/plugin.md
diff --git a/...-fundamentals/04-configuration/pruning.md → .../fundamentals/04-configuration/pruning.md b/...-fundamentals/04-configuration/pruning.md → .../fundamentals/04-configuration/pruning.md
diff --git a/...-fundamentals/04-configuration/receipt.md → .../fundamentals/04-configuration/receipt.md b/...-fundamentals/04-configuration/receipt.md → .../fundamentals/04-configuration/receipt.md
diff --git a/...04-configuration/sample-configuration.mdx → ...04-configuration/sample-configuration.mdx b/...04-configuration/sample-configuration.mdx → ...04-configuration/sample-configuration.mdx
diff --git a/docs/02-fundamentals/04-configuration/seq.md → docs/fundamentals/04-configuration/seq.md b/docs/02-fundamentals/04-configuration/seq.md → docs/fundamentals/04-configuration/seq.md
diff --git a/.../02-fundamentals/04-configuration/sync.md → docs/fundamentals/04-configuration/sync.md b/.../02-fundamentals/04-configuration/sync.md → docs/fundamentals/04-configuration/sync.md
diff --git a/...ndamentals/04-configuration/tracestore.md → ...ndamentals/04-configuration/tracestore.md b/...ndamentals/04-configuration/tracestore.md → ...ndamentals/04-configuration/tracestore.md
diff --git a/...2-fundamentals/04-configuration/txpool.md → docs/fundamentals/04-configuration/txpool.md b/...2-fundamentals/04-configuration/txpool.md → docs/fundamentals/04-configuration/txpool.md
diff --git a/...2-fundamentals/04-configuration/wallet.md → docs/fundamentals/04-configuration/wallet.md b/...2-fundamentals/04-configuration/wallet.md → docs/fundamentals/04-configuration/wallet.md
diff --git a/docs/02-fundamentals/05-security.md → docs/fundamentals/05-security.md b/docs/02-fundamentals/05-security.md → docs/fundamentals/05-security.md
diff --git a/docs/02-fundamentals/06-logs/_category_.json → docs/fundamentals/06-logs/_category_.json b/docs/02-fundamentals/06-logs/_category_.json → docs/fundamentals/06-logs/_category_.json
diff --git a/...amentals/06-logs/logging-configuration.md → ...amentals/06-logs/logging-configuration.md b/...amentals/06-logs/logging-configuration.md → ...amentals/06-logs/logging-configuration.md
diff --git a/docs/02-fundamentals/06-logs/logs.md → docs/fundamentals/06-logs/logs.md b/docs/02-fundamentals/06-logs/logs.md → docs/fundamentals/06-logs/logs.md
diff --git a/docs/02-fundamentals/07-database.md → docs/fundamentals/07-database.md b/docs/02-fundamentals/07-database.md → docs/fundamentals/07-database.md
diff --git a/.../08-how-to-reduce-database-size/README.md → .../08-how-to-reduce-database-size/README.md b/.../08-how-to-reduce-database-size/README.md → .../08-how-to-reduce-database-size/README.md
diff --git a/...w-to-reduce-database-size/_category_.json → ...w-to-reduce-database-size/_category_.json b/...w-to-reduce-database-size/_category_.json → ...w-to-reduce-database-size/_category_.json
diff --git a/...w-to-reduce-database-size/full-pruning.md → ...w-to-reduce-database-size/full-pruning.md b/...w-to-reduce-database-size/full-pruning.md → ...w-to-reduce-database-size/full-pruning.md
diff --git a/...base-size/resync-database-from-scratch.md → ...base-size/resync-database-from-scratch.md b/...base-size/resync-database-from-scratch.md → ...base-size/resync-database-from-scratch.md
diff --git a/...undamentals/09-private-networks/README.md → ...undamentals/09-private-networks/README.md b/...undamentals/09-private-networks/README.md → ...undamentals/09-private-networks/README.md
diff --git a/...ntals/09-private-networks/_category_.json → ...ntals/09-private-networks/_category_.json b/...ntals/09-private-networks/_category_.json → ...ntals/09-private-networks/_category_.json
diff --git a/...p-a-nethermind-only-clique-based-chain.md → ...p-a-nethermind-only-clique-based-chain.md b/...p-a-nethermind-only-clique-based-chain.md → ...p-a-nethermind-only-clique-based-chain.md
diff --git a/...-nethermind-only-spaceneth-based-chain.md → ...-nethermind-only-spaceneth-based-chain.md b/...-nethermind-only-spaceneth-based-chain.md → ...-nethermind-only-spaceneth-based-chain.md
diff --git a/...ntals/10-running-nethermind-post-merge.md → ...ntals/10-running-nethermind-post-merge.md b/...ntals/10-running-nethermind-post-merge.md → ...ntals/10-running-nethermind-post-merge.md
diff --git a/docs/02-fundamentals/_category_.json → docs/fundamentals/_category_.json b/docs/02-fundamentals/_category_.json → docs/fundamentals/_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/get-started/installing-nethermind.md b/docs/get-started/installing-nethermind.md
@@ -110,7 +110,7 @@ Then, install Nethermind as follows:
 brew install nethermind
 ```
 
-For further instructions, see [Running Nethermind](../02-fundamentals/01-running-nethermind/running-the-client.md).
+For further instructions, see [Running Nethermind](../fundamentals/01-running-nethermind/running-the-client.md).
 
 ## Standalone downloads
 
@@ -187,7 +187,7 @@ To monitor the Nethermind output, run:
 journalctl -u nethermind -f
 ```
 
-For further instructions, see [Running Nethermind](../02-fundamentals/01-running-nethermind/running-the-client.md).
+For further instructions, see [Running Nethermind](../fundamentals/01-running-nethermind/running-the-client.md).
 
 ## Docker container
 
@@ -248,5 +248,5 @@ Note that any Nethermind-specific configuration option can be specified at the e
 
 #### See also
 
-- [Configuration options](../02-fundamentals/04-configuration/README.md)
+- [Configuration options](../fundamentals/04-configuration/README.md)
 - [Building Docker image](../developers/building-from-source.md#bulding-docker-image)
diff --git a/docs/get-started/migrating-from-geth.md b/docs/get-started/migrating-from-geth.md
@@ -35,7 +35,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/10-running-nethermind-post-merge.md#step-2-installing-consensus-client)
+a [#step-2-installing-consensus-client](../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.
 
@@ -55,7 +55,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/10-running-nethermind-post-merge.md#step-4-run-nethermind)for
+Please refer to a [#step-4-run-nethermind](../fundamentals/10-running-nethermind-post-merge.md#step-4-run-nethermind)for
 instruction on how to run Nethermind.
 
 :::caution
@@ -164,7 +164,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/10-running-nethermind-post-merge.md#step-1-installing-nethermind) to see
+a [#step-1-installing-nethermind](../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.
@@ -179,7 +179,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/10-running-nethermind-post-merge.md#step-5-run-nethermind)for instruction on how to
+a [#step-4-run-nethermind](../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/get-started/system-requirements.md b/docs/get-started/system-requirements.md
@@ -49,7 +49,7 @@ Nonetheless, for a comprehensive understanding of disk growth and usage, we reco
 
 #### Database growth
 
-Nethermind requires approximately 504 GB of disk space (as of May 2023) after a fresh Ethereum Mainnet sync using default parameters. This size increases over time as the Ethereum chain grows. The node's database is in its most optimal state immediately after a sync or full pruning. Following the initial sync, the database grows at a rate of approximately 27 GB per week. To maintain this process, occasional resyncing or pruning of the node is necessary to bring it back to its optimal database size. For more info on managing node disk usage growth, see [how to reduce database size](../02-fundamentals/08-how-to-reduce-database-size/README.md).<br />
+Nethermind requires approximately 504 GB of disk space (as of May 2023) after a fresh Ethereum Mainnet sync using default parameters. This size increases over time as the Ethereum chain grows. The node's database is in its most optimal state immediately after a sync or full pruning. Following the initial sync, the database grows at a rate of approximately 27 GB per week. To maintain this process, occasional resyncing or pruning of the node is necessary to bring it back to its optimal database size. For more info on managing node disk usage growth, see [how to reduce database size](../fundamentals/08-how-to-reduce-database-size/README.md).<br />
 Having a larger disk space allocation reduces the need for frequent maintenance and alleviates concerns about the chain outgrowing the available space. It's worth noting that the only drawback of running a smaller disk is the requirement for more regular resyncing or pruning. We believe that a 2 TB disk will suffice for most users. However, the choice between 1 TB and 2 TB depends on factors such as hardware costs, cloud provider expenses, and individual requirements.
 
 #### Disk speed
@@ -64,7 +64,7 @@ A node can be run using different syncing options, and each option has different
 - **Ancient barriers.** Nethermind allows you to specify how many old block bodies and receipts you want to store. By default, Nethermind sets the ancient barrier at block 11052984. This block is significant because it marks the deployment of the deposit contract required for consensus client deposit scanning for validators. Peers and JSON-RPC requests will not have access to block bodies and receipts older than the ancient barrier.
 - **Non-validator mode.** This mode drops all historical receipts and bodies, but it cannot be used for validation.
 
-For more details, see [sync modes](../02-fundamentals/03-sync-modes.md).
+For more details, see [sync modes](../fundamentals/03-sync-modes.md).
 
 #### Database size with different configurations