Update official doc. page (#6)

* add development branch for preview releases

* updates and corrections

* typo corrections

* updated Polygon quicknode page

* updated Gnosis Chain quick node

* Gnosis quicknode formatting error correction

* updates and corrections

* restructured and improved Windows installation documentation

* updated sentry and rpc_daemon, added trace_ module

* updated full node by default, staking, alpha6 etc.

* updated staking, Caplin, RPC, disk space, ports

* added op-node

* updated JSON-RPC, welcome, README

* updated intro page

* small syntax modification

* punctuation

* int chapter more info

* duplicate title

* syntax correction

* minor markdown issues

* small fixes and duplicates removal

* corrected heimdall API

---------

Co-authored-by: bloxster

Author: bloxster

README.md

@@ -1,21 +1,26 @@
 # The Erigon 3 Book
 
-This is the official The Erigon 3 Book, soon online at <https://docs.erigon.tech/>.
+This is the official Erigon 3 documentation, hosted at <https://docs.erigon.tech/>.
 
-It is built on [mdbook](https://rust-lang.github.io/mdBook/). Please take a look at its install instructions first.
 
-## Build
+# Contributing to this documentation
 
-```shell
+To contribute to this documentation, commit your change to the development branch, commitments to the main branch will be ignored.
+
+See how MdBook works [here](https://rust-lang.github.io/mdBook/index.html).
+
+# Build
+
+```bash
 mdbook build
 ```
 
 The compiled book will be available in the `book` subdirectory.
 
-## Run it locally
+# Run it locally
 
-```shell
+```bash
 mdbook serve
 ```
 
-It will start a local HTTP server and serve the book contents at http://localhost:3000/.
+It will start a local HTTP server and serve the book contents at <http://localhost:3000/>.

book.toml

@@ -5,3 +5,6 @@ description = "Erigon 3 documentation!"
 language = "en"
 multilingual = false
 src = "src"
+
+[output.html]
+git-repository-url = "https://github.com/erigontech/docs"

src/SUMMARY.md

@@ -1,6 +1,6 @@
 # Erigon 3 docs summary
 
-- [Welcome to Erigon 3](welcome.md)
+- [Introduction](_introduction.md)
 
 - [Getting Started](getting_started.md)
     - [Hardware Requirements](getting-started/hw-requirements.md)
@@ -23,30 +23,31 @@
     - [Default Ports and Firewalls](basic/ports.md)
     - [Web3 Wallet](basic/wallet)
 
+- [Quick nodes](quick_nodes.md)
+    - [How to run an Ethereum node](nodes/ethereum.md)
+    - [How to run a Gnosis Chain node](nodes/gnosis.md)
+    - [How to run a Polygon node](nodes/polygon.md)
+
 - [Advanced Usage](advanced.md)
     - [Configuring Erigon](advanced/configuring.md)
     - [Consensus Layer](advanced/consensus_layer.md)
         - [Caplin](advanced/caplin.md)
         - [Prysm](advanced/prysm.md)
         - [Lighthouse](advanced/lighthouse.md)
         - [JWT secret](advanced/jwt.md)
-        - [Block production](advanced/block-prod.md)
     - [Options](advanced/options.md)
-    - [RPC Daemon](advanced/rpc_daemon.md)
+    - [RPC Daemon](advanced/JSONRPC-daemon.md)
+        - [The trace Module](advanced/JSONRPC-trace-module.md)
     - [TxPool](advanced/txpool.md)
     - [Sentry](advanced/sentry.md)
     - [Downloader](advanced/downloader.md)
+    - [Running an Op-node](advanced/op-node.md)
     - [TLS Authentication](advanced/tls-authentication.md)
     - [Performance Tricks](advanced/performance.md)
 
- ---
-
-- [Quick nodes](quick_nodes.md)
-    - [Ethereum](nodes/ethereum.md)
-    - [Gnosis](nodes/gnosis.md)
-    - [Polygon](nodes/polygon.md)
-
- ---
+- [Staking](staking.md)
+    - [External CL](advanced/bp-ext.md)
+    - [Caplin](advanced/bp-caplin.md)
 
 - [Tools](tools.md)
     - [Dagnostic Tools](tools/introduction.md)

src/welcome.md src/_introduction.mdsrc/welcome.md renamed to src/_introduction.md

@@ -1,13 +1,5 @@
-# Welcome to Erigon 3!
+# Introduction
              
->
-> **NOTE**: The Erigon 3 book is under construction and you may find broken links, empty pages and inexact information.
-> 
-> For instructions regarding Erigon 2 please refer to <https://erigon.gitbook.io>.
-
-
-
-
 	########b          oo                               d####b. 
 	##                                                      '## 
 	##aaaa    ##d###b. dP .d####b. .d####b. ##d###b.     aaad#' 
@@ -17,20 +9,28 @@
 	                           .##                              
 	                       d####P    
 
-> **DISCLAIMER**: Erigon 3 is in alpha phase and it is not recommended to be used in production environments. The Erigon team does not take any responsibility for losses or damages occurred through the use of Erigon. While we employ a seasoned in-house security team, we have not subjected our systems to independent third-party security assessments, leaving potential vulnerabilities to bugs or malicious activity unaddressed. It is essential for validators to be aware that unforeseen events, including software glitches, may result in lost rewards.
+> 📖 **Contributing**
+>
+> You can contribute to this book on [GitHub](https://github.com/erigontech/docs).
+>  
+> For instructions regarding Erigon 2 please refer to <https://erigon.gitbook.io>.
 
 Erigon is an efficient Ethereum implementation designed for speed, modularity, and optimization. By default, it functions as an archive node, utilizing technologies like staged sync, efficient state storage, and database compression.
 
-With **Erigon v3 Alpha 6**, the default configuration shifts from archive node to full node, enhancing efficiency, accessibility, and versatility for a wider range of users. Archive nodes remain available for developers and researchers needing full historical data, while the full node offers faster sync times and lower resource usage for everyday operations. More info [here](https://erigon.tech/announcing-erigon-v3-alpha-6-focus-on-staking-and-full-node-performance/).
+With Erigon 3 the default configuration shifts from archive node to full node, enhancing efficiency, accessibility, and versatility for a wider range of users. Archive nodes remain available for developers and researchers needing full historical data, while the full node offers faster sync times and lower resource usage for everyday operations. More info [here](https://erigon.tech/announcing-erigon-v3-alpha-6-focus-on-staking-and-full-node-performance/).
 
 <div class="warning">
 
 **Information**
 
-If you wanto to test Erigon in minutes, go straight to the [quick nodes](quick_nodes.md) section.
+If you wanto to test Erigon without reading all the documentation, go straight to the [quick nodes](quick_nodes.md) section.
 
 </div>
 
+> **DISCLAIMER**
+>
+> Erigon 3 is in alpha phase and it is not recommended to be used in production environments. The Erigon team does not take any responsibility for losses or damages occurred through the use of Erigon. While we employ a seasoned in-house security team, we have not subjected our systems to independent third-party security assessments, leaving potential vulnerabilities to bugs or malicious activity unaddressed. It is essential for validators to be aware that unforeseen events, including software glitches, may result in lost rewards.
+
 # Features
 
 Erigon offers several features that make it a good option for a node application such as efficient state storage through the use of a key-value database and faster initial synchronisation.
@@ -47,3 +47,7 @@ Erigon 3 also introduces changes to the release process, including:
 * New Docker Image Repository: Erigon images are now available on Dockerhub repository "erigontech/erigon".
 * Multi-Platform Support: The docker image is built for linux/amd64/v2 and linux/arm64 platforms using Alpine 3.20.2.
 * Release Workflow Changes: Build flags are now passed to the release workflow, allowing users to view previously missed build information in released binaries.
+
+# Known Issues
+
+See <https://github.com/erigontech/erigon?tab=readme-ov-file#known-issues>.

src/about/contributing.md

@@ -6,23 +6,30 @@ Erigon is an open-source project that welcomes contributions from developers wor
 
 ### Programmer's Guide
 
-Begin by exploring the comprehensive [Programmer's Guide](https://github.com/ledgerwatch/erigon/blob/devel/docs/programmers_guide/guide.md), which covers topics such as the Ethereum state structure, account contents, and account addressing mechanisms. This guide serves as a valuable resource, providing detailed information on Erigon's architecture, coding conventions, and development workflows related to managing and interacting with the Ethereum state.
+Begin by exploring the comprehensive **[Programmer's Guide](https://github.com/ledgerwatch/erigon/blob/devel/docs/programmers_guide/guide.md)**, which covers topics such as the Ethereum state structure, account contents, and account addressing mechanisms. This guide serves as a valuable resource, providing detailed information on Erigon's architecture, coding conventions, and development workflows related to managing and interacting with the Ethereum state.
 
 ### Dive Deeper into the Architecture
 
 For those interested in gaining a deeper understanding of Erigon's underlying architecture, visit the following resources:
+
+- **[DB Walk-through](https://github.com/erigontech/erigon/blob/release/2.60/docs/programmers_guide/db_walkthrough.MD)**: This document provides a detailed walk-through of Erigon's database structure. It explains how Erigon organizes persistent data into tables like PlainState for accounts and storage, History Of Accounts for tracking account changes, and Change Sets for optimized binary searches on changes. It contrasts Erigon's approach with go-ethereum's use of the Merkle Patricia Trie.
+- **[Database FAQ](https://github.com/erigontech/erigon/blob/release/2.60/docs/programmers_guide/db_faq.md)**: The Database FAQ addresses common questions and concerns related to Erigon's database design. It covers how to directly read the database via gRPC or while Erigon is running, details on the MDBX storage engine and RAM usage model, and points to further resources on the database interface rationale and architecture.
 - **[DB Walk-through](https://github.com/erigontech/erigon/blob/release/2.60/docs/programmers_guide/db_walkthrough.MD)**: This document provides a detailed walk-through of Erigon's database structure. It explains how Erigon organizes persistent data into tables like PlainState for accounts and storage, History Of Accounts for tracking account changes, and Change Sets for optimized binary searches on changes. It contrasts Erigon's approach with go-ethereum's use of the Merkle Patricia Trie.
 - **[Database FAQ](https://github.com/erigontech/erigon/blob/release/2.60/docs/programmers_guide/db_faq.md)**: The Database FAQ addresses common questions and concerns related to Erigon's database design. It covers how to directly read the database via gRPC or while Erigon is running, details on the MDBX storage engine and RAM usage model, and points to further resources on the database interface rationale and architecture.
-
 
 ### Feature Exploration
+
 Erigon introduces several innovative features that contributors may find interesting to explore and contribute to:
+
+- **[DupSort Feature Explanation](https://github.com/erigontech/erigon/blob/release/2.60/docs/programmers_guide/dupsort.md)**: Erigon's DupSort feature optimizes storage and retrieval of duplicate data by utilizing prefixes for keys in databases without the concept of "Buckets/Tables/Collections" or by creating tables for efficient storage with named "Buckets/Tables/Collections."
+- **[EVM without Opcodes](https://github.com/erigontech/erigon/blob/release/2.60/docs/evm_semantics.md)** (Ether Transfers Only): Erigon explores a simplified version of the Ethereum Virtual Machine (EVM) focusing solely on ether transfers, offering an efficient execution environment for specific use cases.
 - **[DupSort Feature Explanation](https://github.com/erigontech/erigon/blob/release/2.60/docs/programmers_guide/dupsort.md)**: Erigon's DupSort feature optimizes storage and retrieval of duplicate data by utilizing prefixes for keys in databases without the concept of "Buckets/Tables/Collections" or by creating tables for efficient storage with named "Buckets/Tables/Collections."
 - **[EVM without Opcodes](https://github.com/erigontech/erigon/blob/release/2.60/docs/evm_semantics.md)** (Ether Transfers Only): Erigon explores a simplified version of the Ethereum Virtual Machine (EVM) focusing solely on ether transfers, offering an efficient execution environment for specific use cases.
 
 ## Wiki
 
-Visit also Erigon's [Wiki](https://github.com/ledgerwatch/erigon/wiki) to gain more important insights:
+Visit also Erigon's **[Wiki](https://github.com/ledgerwatch/erigon/wiki)** to gain more important insights:
+
 - Caplin downloader sync
 - Choice of storage engine
 - Consensus Engine separation
@@ -40,4 +47,4 @@ Visit also Erigon's [Wiki](https://github.com/ledgerwatch/erigon/wiki) to gain m
 
 # Documentation
 
-To contribute to this documentation, commit your change to the development branch on [Github](https://github.com/erigontech/docs/tree/development). You might want to run it locally to verify the output before committing, see how MdBook works [here](https://rust-lang.github.io/mdBook/index.html).
+To contribute to this documentation, commit your change to the development branch on **[Github](https://github.com/erigontech/docs/tree/development)**. You might want to run it locally to verify the output before committing, see how MdBook works [here](https://rust-lang.github.io/mdBook/index.html).

src/about/license.md

@@ -1,3 +1,3 @@
 # License
 
-The Erigon 3 documentation © 2024 by Erigon contributors is licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/).
+The Erigon 3 Book © 2024 by Erigon contributors is licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/).