Skip to content

Commit ed0486e

Browse files
committed
refactoring
1 parent 24bc7fe commit ed0486e

12 files changed

Lines changed: 26 additions & 28 deletions

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ hide:
1111
</h1>
1212
<span class="subtitle">documentation</span>
1313
<p class="description">
14-
This documentation provides everything you need to get started with Web3 Pi.<br>Find step-by-step guides for setup, detailed explanations of features, monitoring tools, troubleshooting tips for running your Ethereum node smoothly on Raspberry Pi.
14+
This documentation provides everything you need to get started with Web3 Pi.<br>Find step-by-step guides for setup, detailed explanations of features, monitoring tools, troubleshooting and tips for running your Ethereum node smoothly on Raspberry Pi.
1515
</p>
1616
<a href="/setup/prerequisites" class="md-button md-button--primary">
1717
Get Started

docs/introduction/next-steps.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,14 @@ If you're unsure, we recommend starting with a single device setup.
1919

2020
Ensure you have all the necessary hardware components (Raspberry Pi, power supply, storage, network cable, etc.).
2121

22-
### Use Your Own Hardware or the Welcome Box?
22+
### Use Your Own Hardware or the WelcomeBox?
2323

24-
- [**Welcome Box:**](../welcome-box/index.md) Web3 Pi offers a Welcome Box — an all-in-one solution with pre-selected, compatible hardware to help you get started quickly.
24+
- [**WelcomeBox:**](../welcome-box/index.md) Web3 Pi offers a WelcomeBox — an all-in-one solution with pre-selected, compatible hardware to help you get started quickly.
2525
- **Own Hardware:** You can use your existing Raspberry Pi (Model 4, 5, or CM4) and compatible peripherals. Ensure you have everything required by checking the [Prerequisites Guide](../setup/prerequisites.md) and the [Hardware Recommendations](./single-mode/hardware-recommendations.md) document.
2626

2727
### Optional LCD Display?
2828

29-
- You can add an optional LCD display to your setup for at-a-glance monitoring. It's included in the Welcome Box and natively supported by the Web3 Pi system — just plug it in, no installation or configuration needed.
29+
- You can add an optional LCD display to your setup for at-a-glance monitoring. It's included in the WelcomeBox and natively supported by the Web3 Pi system — just plug it in, no installation or configuration needed.
3030
Details are in the [LCD Monitoring Guide](../monitoring/lcd.md).
3131

3232
## 3. Set Up Your Node

docs/introduction/staking.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
Running a standard Ethereum node with Web3 Pi does not directly generate income by itself. Its primary purpose is providing secure, private, and performant access to the blockchain. However, Web3 Pi serves as a foundation for potential earning opportunities:
88

99
* **Solo Staking:** While running a node doesn't require 32 ETH, staking to secure the network and earn rewards does. Web3 Pi hardware (like Raspberry Pi 5) is capable of handling staking duties (proven in tests running 200 validators), although the setup currently requires manual configuration. We aim to simplify this process significantly in the future.
10-
* **RPC Monetization:** Through collaborations like the one with Golem Network, there are plans to allow Web3 Pi node operators to share RPC endpoint and potentially earn rewards (e.g., in GLM tokens) for serving requests. (This feature is not yet available.)
10+
* **RPC Monetization:** Through collaborations like the one with Golem Network, there are plans to allow Web3 Pi node operators to share RPC endpoint and potentially earn rewards (e.g., in GLM tokens) for serving requests. This feature is not yet available.
1111

1212
If you are considering staking, it is crucial that you thoroughly research and understand the process, responsibilities, and significant risks involved before attempting it.
1313

docs/setup/dual-mode/hardware-assembly.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,5 +53,3 @@ Double-check your labels and component placement one last time.
5353
## Next Steps
5454

5555
With both devices assembled correctly, you are ready to connect them to your network and begin the software installation and synchronization process.
56-
57-
➡️ Proceed to the [**Dual-Device Installation Monitoring Guide**](./installation-monitoring.md)

docs/setup/dual-mode/hardware-recommendations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Supported combinations include:
99
- Two Raspberry Pi 5
1010
- Two Raspberry Pi 4
1111
- One Raspberry Pi 5 and one Raspberry Pi 4
12-
- Any combination including Compute Module 4 (CM4)
12+
- Any combination including Compute Module 4/5
1313

1414
## Raspberry Pi Models
1515

docs/setup/dual-mode/software-setup.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ For Dual Mode device, the following settings can be configured. In this mode, we
3333

3434
## Advanced Options
3535

36-
If you click the Advanced button, you can configure these additional options. These advanced settings will be applied to both the execution layer device and the consensus layer device:
36+
If you click the **ADVANCED** button, you can configure these additional options. These advanced settings will be applied to both the execution layer device and the consensus layer device:
3737

3838
* **Execution endpoint address:** Optional custom endpoint for execution client
3939
* **Locale settings:** Including:
@@ -52,7 +52,7 @@ If you click the Advanced button, you can configure these additional options. Th
5252

5353
## Drive Selection
5454

55-
After setting up the configuration and clicking "Next", a dialog box will appear allowing you to select the drive where the image with settings will be saved.
55+
After setting up the configuration and clicking **NEXT**, a dialog box will appear allowing you to select the drive where the image with settings will be saved.
5656

5757
* **Drive selection:** The list shows available storage devices
5858
* **Display options:**
@@ -114,7 +114,7 @@ Now the process of writing the card for the consensus layer device will begin.
114114
## Final Steps
115115

116116
Now that you have both cards prepared, you will see a message about the possibility of installing the prepared cards in the appropriate devices.
117-
At this stage, you can click "Next" and complete the process. In the following steps, you will be able to assemble both devices and install the prepared cards in the corresponding slots.
117+
At this stage, you can click **NEXT** and complete the process. In the following steps, you will be able to assemble both devices and install the prepared cards in the corresponding slots.
118118

119119
![Final screen](../img/dual/w3p-inserting.png){ width=700px }
120120
![Final screen](../img/dual/w3p-finish.png){ width=700px }

docs/setup/prerequisites.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,6 @@ For those who prefer a guaranteed-compatible, all-in-one solution, the [Web3 Pi
4040

4141
If you would prefer to use your own existing Raspberry Pi, please read the [Hardware Checklist](./single-mode/hardware-checklist.md) to make sure you have everything you need. If you need to purchase anything further, the [Hardware Recommendations](./single-mode/hardware-recommendations.md) document will help you choose suitable additions to your existing setup.
4242

43-
Optionally, you can also purchase an [LCD screen](https://www.waveshare.com/1.69inch-lcd-module.htm) for the Pi. This gives you a quick way of checking that your node is functional. The LCD screen is included in the Welcome Box.
43+
Optionally, you can also purchase an [LCD screen](https://www.waveshare.com/1.69inch-lcd-module.htm) for the Pi. This gives you a quick way of checking that your node is functional. The LCD screen is included in the WelcomeBox.
4444

4545
---

docs/setup/single-mode/hardware-assembly.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Place the thermal pads on the CPU, RP1, RAM and PMIC Chip of the RPi 5.
4444

4545
There are different versions of this case on the market:
4646
* If you have four thermal pads, place them in the areas marked in blue.
47-
* If you have two thermal pads in the set, place them on the CPU and PMIC (bottom left corner, near the USB-C connector).
47+
* If you have two thermal pads in the set, place them on the CPU and PMIC (left corner, near the USB-C connector).
4848

4949
![Thermal pad placement diagram](../img/assembly/thermal.png)
5050

docs/setup/single-mode/hardware-checklist.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ You can run a single device node on any of the following.
1414

1515
- Raspberry Pi 4 - [see full details](#raspberry-pi-4)
1616

17-
- Raspberry Pi CM4 - [see ful details](#raspberry-pi-cm4)
17+
- Raspberry Pi CM4/5 - [see ful details](#raspberry-pi-compute-module)
1818

1919
Optionally, you can add an [LCD display](../../monitoring/lcd.md) for monitoring purposes.
2020

@@ -25,7 +25,7 @@ Optionally, you can add an [LCD display](../../monitoring/lcd.md) for monitoring
2525
- 1 X [SD Card reader/writer](./hardware-recommendations.md#sd-card-reader-and-writer)
2626
- 1 x [microSD Card](./hardware-recommendations.md#microsd-card)
2727
- 1 x [Power supply](https://botland.store/raspberry-pi-5-power-supply/23907-raspberry-pi-27w-usb-c-power-supply-official-51v-5a-psu-for-raspberry-pi-5-black-5056561803418.html)
28-
- 1 X [Raspberry Pi 5 Active Cooler]([Raspberry Pi Active Cooler - heatsink + fan for Raspberry Pi 5 Botland - Robotic Shop](https://botland.store/raspberry-pi-5-mounting-elements/23925-raspberry-pi-active-cooler-heatsink-fan-for-raspberry-pi-5-5056561803357.html)
28+
- 1 x [Raspberry Pi 5 Active Cooler](https://botland.store/raspberry-pi-5-mounting-elements/23925-raspberry-pi-active-cooler-heatsink-fan-for-raspberry-pi-5-5056561803357.html)
2929

3030
### Raspberry Pi 4
3131

@@ -36,20 +36,20 @@ Optionally, you can add an [LCD display](../../monitoring/lcd.md) for monitoring
3636
- 1 X [Raspberry Pi 4 Active Cooler](https://botland.store/raspberry-pi-4b-cases/15106-case-justpi-for-raspberry-pi-4b-aluminum-with-dual-fan-black-lt-4b02-5903351242660.html)
3737
- 1 x [Power supply](https://botland.store/raspberry-pi-4b-power-supply/14348-power-supply-for-raspberry-pi-4-usb-c-51v-3a-original-black-644824914886.html)
3838

39-
### Raspberry Pi CM4
39+
### Raspberry Pi Compute Module
4040

41-
The CM4 module needs a carrier board. There are many on the market.
41+
The CM4/5 module needs a carrier board. There are many on the market.
4242

4343
Minimum requiments are:
4444

45-
- 1 x [Raspberry Pi CM4 (8GB)](https://botland.store/raspberry-pi-cm/18211-raspberry-pi-cm4-compute-module-4-8gb-ram-32gb-emmc-wifibluetooth-cm4108032-5904422368593.html)
45+
- 1 x Raspberry Pi CM4/CM5 8GB
4646
- 1 x [2TB fast storage](./hardware-recommendations.md#ssd-drive)
4747
- 1 x Power supply
48-
- 1 X [Raspberry Pi CM4 Active Cooler]((https://botland.store/raspberry-pi-cm/21716-dedicated-all-in-one-3007-cooling-fan-for-raspberry-pi-cm4-waveshare-22096.htm)
49-
- 32GB+ storage for operating system (microSD or eMMC)
50-
- 1 X Motherboard
48+
- 1 x Raspberry Pi CM4 Active Cooler
49+
- 1 x 32GB+ storage for operating system (microSD or eMMC)
50+
- 1 x Motherboard
5151

52-
Installing Web3 Pi on the CM4 requires more knowledge. CM4 modules come with built-in eMMC memory, and in this case, you need to use the **rpiboot** application before using the Raspberry Pi Imager. If your module does not have built-in memory and uses an SD card, the installation process is similar to a standard Raspberry Pi.
52+
Installing Web3 Pi on the CM4/5 requires more knowledge. CM4/5 modules come with built-in eMMC memory, and in this case, you need to use the **rpiboot** application before using the Raspberry Pi Imager. If your module does not have built-in memory and uses an SD card, the installation process is similar to a standard Raspberry Pi.
5353

5454
More information can be found on the manufacturer's website: [Raspberry Pi Documentation](https://www.raspberrypi.com/documentation/computers/compute-module.html).
5555

docs/setup/single-mode/hardware-recommendations.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ You can also use a USB to SATA adapter plus SSD 2.5" drive.
3030

3131
| Brand | Storage | Model | Link\* | Comment |
3232
| ------- | ------- | -------------- | ---------------------------------------------------------------------------------------- | -------------------------------------------------------------------- |
33-
| Samsung | 2 TB | T7 2TB USB 3.2 | https://tweakers.net/pricewatch/1560668/samsung-portable-ssd-t7-2tb-grijs/specificaties/ | **Recommended for most users. Compatible with Raspberry Pi 4 and 4** |
33+
| Samsung | 2 TB | T7 2TB USB 3.2 | https://tweakers.net/pricewatch/1560668/samsung-portable-ssd-t7-2tb-grijs/specificaties/ | **Recommended for most users. Compatible with Raspberry Pi 4 and 5** |
3434

3535
**Tip:** Some external disks consume more power than Raspberry Pi can deliver via USB. For Raspberry Pi 5, the max power output of the USB ports is 600mA if you're using a 3A supply, and1600mA if you're using a 5A supply. You can edit `/boot/firmware/config.txt` and add `usb_max_current_enable=1` to disable the current limit. Please read the documentation:
3636

@@ -82,7 +82,7 @@ We do not recommend the following:
8282
| Brand | Link\* |
8383
| ------- | ---------------------------------------------------------------------------------------------------- |
8484
| ZenWire | https://zenwire.eu/pl/p/Adapter-SSD-M2-NVMESATA-kieszen-na-dysk-obudowa-M.2-USB-C-10-GBs-Zenwire/289 |
85-
| RIITOP | https://www.amazon.nl/dp/B0B1HVGBZ3?ref_=pe_28126711_487767311_302_E_DDE_dt_1 |
85+
| RIITOP | https://www.amazon.nl/dp/B0B1HVGBZ3 |
8686
| QOLTEC | https://www.tme.eu/en/details/qoltec-50311/hdd-ssd-accessories/qoltec/50311/ |
8787

8888
or other similar.

0 commit comments

Comments
 (0)