docs: small revision to the documentation (#512)

chong-he · web-flow · commit 1be53b29c854 · 2025-08-19T10:35:42.000Z
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -91,7 +91,7 @@ having trouble. As always, jump on [discord](https://discord.gg/cyAszAh)
 if you get stuck.
 
 Additionally,
-the ["Contributing to Anchor" section](https://anchor-book.sigmaprime.io/contributing.html#contributing-to-anchor)
+the ["Contributing" section](https://anchor.sigmaprime.io/contributing)
 of the Anchor Book provides more details on the setup.
 
 ## FAQs
diff --git a/README.md b/README.md
@@ -39,7 +39,7 @@ Anchor maintains two permanent branches:
 Anchor welcomes contributors.
 
 If you are looking to contribute, please head to the
-[Contributing](https://anchor-book.sigmaprime.io/contributing.html) section
+[Contributing](https://anchor.sigmaprime.io/contributing) section
 of the Anchor book.
 
 ## Contact
diff --git a/docs/docs/pages/cli-keygen.mdx b/docs/docs/pages/cli-keygen.mdx
@@ -35,5 +35,4 @@ Anchor.
 anchor keygen --encrypt --output-path /path/to/keys
 ```
 
-Anchor will look for the key file inside the directory specific by `--datadir`, unless you
-specify it via `--key-file`.
+Anchor will look for the key file in the default directory `~/.anchor/{network}`, or the directory specified by `--datadir`.
diff --git a/docs/docs/pages/cli-node.mdx b/docs/docs/pages/cli-node.mdx
@@ -34,7 +34,7 @@ anchor node [OPTIONS]
 | --- | --- | ---|
 | `--metrics` | Enable metrics server | Disabled |
 | `--metrics-address <ADDRESS>` | Listen address for metrics server | `127.0.0.1` if `--metrics` is set |
-| `--metrics-port <PORT>` | Listen port for metrics server | `15000` if `--metrics` is set |
+| `--metrics-port <PORT>` | Listen port for metrics server | `5164` if `--metrics` is set |
 
 #### Network Options
 
diff --git a/docs/docs/pages/development_environment.mdx b/docs/docs/pages/development_environment.mdx
@@ -28,7 +28,7 @@ As with most other Rust projects, Anchor uses `cargo test` for unit and
 integration tests. For example, to test the `qbft` crate run:
 
 ```bash
-cd src/qbft
+cd anchor/common/qbft
 cargo test
 ```
 
diff --git a/docs/docs/pages/installation.mdx b/docs/docs/pages/installation.mdx
@@ -1,9 +1,19 @@
 
 # Anchor Installation Guide
 
-This guide provides step-by-step instructions for installing **Anchor**.
+This guide provides step-by-step instructions for installing Anchor.
 
----
+## Recommended System Requirements
+
+Anchor itself is a light-weight client when run alone.
+However, as Anchor needs to connect to a beacon node and an execution client, this implies that a complete setup will require
+the hardware specifications equivalent to running an Ethereum node.
+
+| Hardware | Hoodi testnet | 
+|--------|---------|
+| CPU | AMD Ryzen, Intel Broadwell, ARMv8 or newer |
+| Memory | 16 GB RAM |
+| Storage | 200 GB |
 
 ## 1. Download the Latest Release from GitHub
 
@@ -14,11 +24,14 @@ This guide provides step-by-step instructions for installing **Anchor**.
 ### Example
 
 ```bash
-wget https://github.com/sigp/anchor/releases/download/<version>/anchor-<platform>.tar.gz
-
+# General download link format 
 # Replace <version> and <platform> with the appropriate values.
+wget https://github.com/sigp/anchor/releases/download/<version>/anchor-<version>-<platform>.tar.gz
+tar -xvf anchor-<version>-<platform>.tar.gz
 
-tar -xvf anchor-<platform>.tar.gz
+# Specific version example
+https://github.com/sigp/anchor/releases/download/v0.3.1/anchor-v0.3.1-x86_64-unknown-linux-gnu.tar.gz
+tar -xvf anchor-v0.3.1-x86_64-unknown-linux-gnu.tar.gz
 sudo mv anchor /usr/local/bin/
 ```
 
@@ -38,10 +51,10 @@ anchor node --version
    docker pull sigp/anchor:latest
    ```
 
-2. Run the Anchor container:
+2. Verify the installation:
 
    ```bash
-   docker run --rm -it sigp/anchor:latest --help
+   docker run --rm -it sigp/anchor:latest node --version
    ```
 
 ## 3. Clone and Build Locally
diff --git a/docs/docs/pages/introduction.mdx b/docs/docs/pages/introduction.mdx
@@ -10,7 +10,8 @@ production setting.
 
 ## What is SSV?
 
-Secret Shared Validators (SSV) is a protocol that splits a validator key into multiple shares, distributed across different operators. This approach provides:
+Secret Shared Validators (SSV) is a protocol that splits a validator key into multiple shares, distributed across different operators. 
+Instead of running a validator on a single machine, SSV splits the validator's duties across multiple operators, creating a more resilient and decentralized staking infrastructure. This approach provides:
 
 - **Fault Tolerance**: Your validator remains online even if some operators go offline
 - **No Single Point of Failure**: No single operator can compromise your validator
@@ -19,95 +20,33 @@ Secret Shared Validators (SSV) is a protocol that splits a validator key into mu
 
 ## Why Choose Anchor?
 
-Anchor stands out as an SSV client with several key advantages:
-
-### 🔒 **Security First**
-- Written in Rust for memory safety and security
-- Comprehensive fuzzing and security testing
-- Built by Sigma Prime, trusted Ethereum infrastructure experts
-
-### ⚡ **High Performance**
-- Optimized for efficiency and low resource usage
-- Fast consensus and networking implementation
-- Minimal latency for time-sensitive validator duties
-
-### 🛠️ **Developer Friendly**
-- Clean, well-documented codebase
-- Extensive CLI tools for key management and operations
-- Active open-source development
+Written in Rust, Anchor focuses on memory safety and security. As an independent implementation of the SSV protocol,
+Anchor promotes client diversity in the SSV space, reducing the risk of network-wide failures. Anchor is optimized for 
+efficiency, fast consensus and networking implementation.
 
 ## Who Should Use Anchor?
 
-### Staking Pool Operators
-Run distributed validators with enhanced security and fault tolerance for your staking infrastructure.
-
-### Solo Stakers
-Increase the reliability of your validator setup by distributing risk across multiple operators.
-
-### SSV Network Operators
-Operate as part of the SSV network, providing validator services to other users.
-
-## Quick Start Paths
-
-Choose your path based on your role:
-
-:::code-group
-
-```bash [🎯 New to SSV]
-# Start here to understand the basics
-→ Read: What is SSV?
-→ Next: Installation Guide
-```
-
-```bash [⚙️ Run an Operator]
-# Become an SSV network operator
-→ Next: Installation → Running an Operator
-→ Then: Operator Configuration
-```
-
-```bash [🔑 Manage Keys]
-# Generate and split validator keys
-→ Next: Installation → CLI Reference
-→ Focus: Keygen and KeySplit tools
-```
-
-```bash [🧑‍💻 Developer]
-# Contribute or integrate
-→ Next: Development Environment
-→ Then: Architecture Overview
-```
-
-:::
-
-## Prerequisites
-
-Before getting started, ensure you have:
-
-- **System Requirements**: Linux, macOS, or Windows
-- **Rust** (if building from source): Version 1.88.0 or later
-- **Ethereum Knowledge**: Basic understanding of validators and staking
-- **Command Line**: Comfort with terminal/command prompt usage
+Anyone with a running staking infrastructure can opt to additionally run Anchor and become part of the SSV network.
+This includes staking pool operators, node operators and solo stakers.    
 
 ## What's Next?
 
 1. **[Installation](/installation)** - Get Anchor running on your system
 2. **[Running an Operator](/running_an_operator)** - Start operating in the SSV network
 3. **[CLI Reference](/cli)** - Master the command-line tools
 4. **[Architecture](/architecture)** - Understand Anchor's technical design
+5. **[SSV documentation](https://docs.ssv.network/learn/introduction)** - read more about the SSV network 
+                           
 
 ## About This Documentation
 
-This documentation is open source and community-driven. We welcome contributions to help improve the experience for all users.
-
-- **Contribute**: [github.com/sigp/anchor/docs](https://github.com/sigp/anchor/tree/unstable/docs)
-- **Community Support**: [GitHub Discussions](https://github.com/sigp/anchor/discussions)
-- **Professional Support**: [Sigma Prime](https://sigmaprime.io)
+This documentation is open source and community-driven. We welcome [contributions](https://github.com/sigp/anchor/tree/unstable/docs) to help improve the experience for all users.
 
 ---
 
 :::tip
 Need Help?
 - Check our [FAQ](/faq) for common questions
-- Join the community on [GitHub](https://github.com/sigp/anchor)
+- Join the community on [Discord](https://discord.com/invite/cyAszAh)
 - Report issues or request features in our [issue tracker](https://github.com/sigp/anchor/issues)
 :::
diff --git a/docs/docs/pages/metrics.mdx b/docs/docs/pages/metrics.mdx
@@ -1,7 +1,7 @@
 # Metrics
 
 Anchor comes pre-built with a suite of metrics for developers or users to monitor the health
-and performance of their node.
+and performance of the node.
 
 They must be enabled at runtime using the `--metrics` CLI flag.
 
diff --git a/docs/docs/pages/running_an_operator.mdx b/docs/docs/pages/running_an_operator.mdx
@@ -27,7 +27,7 @@ Save your public key as you'll need it for on-chain registration. **Back up your
 
 **Step 2: Register as an Operator on the SSV Network**
 
-To register an operator, follow the instructions for the official
+To register an operator, follow the instructions in the official
 [ssv docs](https://docs.ssv.network/operators/operator-management/registration).
 
 **Step 3: Configure and run your Anchor node**
diff --git a/docs/docs/pages/what_is_ssv.mdx b/docs/docs/pages/what_is_ssv.mdx
diff --git a/docs/vocs.config.ts b/docs/vocs.config.ts
@@ -10,10 +10,12 @@ export default defineConfig({
   // Community-focused
   aiCta: false,
 
+  // Enable theme toggle
+  themeToggle: true,
+
   // Open source theme - matching design3 background and theming
   theme: {
     accentColor: '#00d4aa',
-    colorScheme: 'dark',
     variables: {
       color: {
         background: { light: '#ffffff', dark: '#0a0a0a' },
@@ -52,20 +54,20 @@ export default defineConfig({
         text: 'Getting Started',
         items: [
           { text: 'Introduction', link: '/introduction' },
-          { text: 'What is SSV?', link: '/what_is_ssv' },
           { text: 'Installation', link: '/installation' },
           { text: 'Running an Operator', link: '/running_an_operator' },
         ]
       },
       {
         text: 'Usage & Configuration',
         items: [
-          { text: 'CLI Reference', link: '/cli', collapsed: true,
+          {
+            text: 'CLI Reference', link: '/cli', collapsed: true,
             items: [
-                    { text: 'Node', link: '/cli-node' },
-                    { text: 'Keygen', link: '/cli-keygen' },
-                    { text: 'KeySplit', link: '/cli-keysplit' },
-                   ]
+              { text: 'Node', link: '/cli-node' },
+              { text: 'Keygen', link: '/cli-keygen' },
+              { text: 'KeySplit', link: '/cli-keysplit' },
+            ]
           },
           { text: 'Metrics', link: '/metrics' },
           { text: 'Advanced Networking', link: '/advanced_networking' },
@@ -76,8 +78,10 @@ export default defineConfig({
         text: 'Development',
         items: [
           { text: 'Development Environment', link: '/development_environment' },
-          { text: 'Protocol Developers', link: '/protocol_developers', collapsed: true,
-            items: [ {text: 'SSV Handshake Protocol', link: '/handshake' } ] },
+          {
+            text: 'Protocol Developers', link: '/protocol_developers', collapsed: true,
+            items: [{ text: 'SSV Handshake Protocol', link: '/handshake' }]
+          },
           { text: 'Architecture', link: '/architecture' },
           { text: 'Contributing', link: '/contributing' },
         ]
diff --git a/metrics/README.md b/metrics/README.md
@@ -6,7 +6,7 @@ Here we provides a `docker-compose` environment which scrapes metrics from Ancho
 nodes using Prometheus and presents them in a browser-based Grafana GUI.
 
 For in-depth details on running metrics, please see the [anchor
-book](https://anchor-book.sigmaprime.io).
+book](https://anchor.sigmaprime.io).
 
 ## Basic Usage
 
