Improve installation telemetry language + add system requirements (#23)

* Improve installation telemetry language + add system requirements

.pre-commit-config.yaml

@@ -3,7 +3,6 @@ repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v2.3.0
     hooks:
-    - id: check-yaml
     - id: end-of-file-fixer
     - id: trailing-whitespace
     - id: check-executables-have-shebangs

docs/installation/installation.md

@@ -32,13 +32,14 @@ export VOINETWORK_SKIP_WALLET_SETUP=1
 /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/VoiNetwork/voi-swarm/main/install.sh)"
 ```
 
-## Setting a Custom Telemetry Name as part of installation (advanced)
+## Setting a Custom Telemetry Name as Part of Installation (advanced)
 
 !!! info
-    This is an advanced feature and is not required to have telemetry configured.
+    This is an advanced feature intended for automation, and is **not required** before telemetry can be used.
 
-During installation, you will be prompted to set a custom telemetry name, if however you prefer to set a name through
-the environment, you can do so by setting the **VOINETWORK_TELEMETRY_NAME** environment variable to your desired name.
+During installation, you will automatically be prompted to set a custom telemetry name if not set already.
+If you prefer to set a name through the environment, you can do so by setting the
+**VOINETWORK_TELEMETRY_NAME** environment variable to your desired name.
 
 This would typically be done if you are automating the installation process.
 

docs/installation/prerequisites.md

@@ -7,10 +7,3 @@
 
 If any package is not available on your system, or if you do not have permission to use said package, follow operating
 system guidance on installation and setup.
-
-## Supported Operating Systems and Compute Platforms
-
-| Operating Systems | Compute Platforms |
-|-------------------|-------------------|
-| Debian            | arm64/amd64       |
-| Ubuntu            | arm64/amd64       |

docs/installation/system-requirements.md

@@ -0,0 +1,31 @@
+# System requirements
+
+## Supported Operating Systems and Compute Platforms
+
+| Operating Systems | Compute Platforms |
+|-------------------|-------------------|
+| Debian            | arm64/amd64       |
+| Ubuntu            | arm64/amd64       |
+
+## Compute Requirements and Recommendations
+
+| Minimum Requirements | Recommended Requirements |
+|----------------------|--------------------------|
+| 4 CPU cores          | 8 CPU cores              |
+| 8 GB RAM             | 16 GB RAM                |
+| 100 GB storage       | 200 GB storage           |
+| 100 Mbps network     | 1 Gbps network           |
+
+!!! note
+    The above requirements are based on the assumption that the node will be running on a dedicated machine.
+    If you are running other services on the same machine, you may need to adjust the requirements accordingly.
+
+## Why These Requirements?
+
+The consensus algorithm used by the network is based on a protocol
+that benefits from fast response times and high availability.
+The requirements are set to ensure that the node can keep up with the network and provide good node health which
+benefits the network as a whole, including the node runner.
+If you are unable to meet these requirements, you may still be able to run a node.
+However, it may not be as beneficial to the network or to you,
+as your node won't be able to earn rewards effectively.

mkdocs.yml

@@ -81,6 +81,7 @@ extra_css:
 nav:
   - Home: index.md
   - Installation:
+        - System requirements: installation/system-requirements.md
         - Prerequisites: installation/prerequisites.md
         - Installation: installation/installation.md
         - Uninstall: installation/uninstall.md