PoS WIP

Author: nadimkobeissi

docs/pos/howto/operating/access-node.md

@@ -8,7 +8,7 @@ New developers on the Polygon network can use Alchemy as their node provider bec
 
 :::
 
-## Send Your First Blockchain Request
+## Send your first blockchain request
 
 This guide assumes you already have an [Alchemy account](https://alchemy.com/?r=e68b2f77-7fc7-4ef7-8e9c-cdfea869b9b5) and access to the [Alchemy Dashboard](https://dashboard.alchemyapi.io).
 
@@ -28,7 +28,7 @@ First, you'll need an Alchemy API key to authenticate your requests. You can [cr
 
 ![img](https://files.readme.io/f0dbb19-ezgif.com-gif-maker_1.gif)
 
-### Make Your First CURL Request
+### Making a cURL request
 
 You can interact with Alchemy's Polygon infrastructure provider using JSON-RPC and your [command line interface](https://www.computerhope.com/jargon/c/commandi.htm).
 
@@ -64,7 +64,7 @@ Results:
   "result": "0x09184e72a000" // 10000000000000 }
 ```
 
-## Set Up the Alchemy SDK
+## Alchemy SDK setup
 
 To make blockchain requests directly from your Javascript / Node.js dApp, you'll need to integrate the **Alchemy SDK**, the easiest and most powerful way to access the blockchain and Alchemy's suite of enhanced APIs.
 
@@ -125,13 +125,13 @@ main();
 
 If you are unfamiliar with the async stuff, check out this [Medium post](https://betterprogramming.pub/understanding-async-await-in-javascript-1d81bb079b2c).
 
-### Run `index.js` Using node
+### Run `index.js` using node.js
 
 ```bash
 node index.js
 ```
 
-### Output in Your Console
+### Console output
 
 You should now see the latest block number output in your console.
 
@@ -147,15 +147,15 @@ The project associated with your API key should now look like this on the dashbo
 
 ![img](https://files.readme.io/bcfc9ff-Alchemy_Tutorial_Result2.png)
 
-## Start Building
+## Start building
 
 Don't know where to start? Check out these tutorials to get more familiar with Alchemy and blockchain development:
 
 1. [Examples of Common Queries Using the Alchemy SDK](https://docs.alchemy.com/reference/using-the-alchemy-sdk)
 3. Learn [How to Send Transactions on Ethereum](https://docs.alchemy.com/docs/how-to-send-transactions-on-ethereum)
 4. Try deploying your first [Hello World Smart Contract](https://docs.alchemy.com/docs/hello-world-smart-contract) and get your hands dirty with some solidity programming!
 
-### Other Web3 Libraries
+### Other Web3 libraries
 
 There are a number of alternative Web3 libraries other than the Alchemy SDK you may already be using. See the documentation for these libraries below:
 

docs/pos/howto/operating/archive-node.md

@@ -1,14 +1,17 @@
-## Get access to an Archive Node with NodeReal
+## Get access to an archive node with NodeReal
 
 If you're new to Web3 development, [NodeReal](https://nodereal.io/) simplifies the process of setting up a full node on Polygon.
 
-:::tip Simplify Polygon node usage with NodeReal and its quality assurance capabilities
+!!! tip Simplify Polygon node usage with NodeReal and its quality assurance capabilities
 
-Many developers prefer to use a node provider when getting started on Polygon, or any chain for that matter, as it offers a quick and easy way to handle requests and responses. NodeReal offers a range of features for developers looking for a node provider on the Polygon network. These features include a Standard Interface that simplifies node usage, as well as reliability and scalability for optimal performance. Additionally, NodeReal offers Archive Data for secure data storage, and an API Marketplace that provides additional resources for developers looking to build on Polygon.
+    Many developers prefer to use a node provider when getting started on Polygon, or any chain for that matter, as it offers a quick and easy way to handle requests and responses.
+    
+    NodeReal offers a range of features for developers looking for a node provider on the Polygon network. These features include a Standard Interface that simplifies node usage, as well as reliability and scalability for optimal performance. 
+    
+    Additionally, NodeReal offers Archive Data for secure data storage, and an API Marketplace that provides additional resources for developers looking to build on Polygon.
 
-:::
 
-## Send Your First Blockchain API Request
+## Send your first blockchain API request
 
 If you haven't signed up for a MegaNode account yet, you can find a step-by-step guide to getting started [here](https://docs.nodereal.io/docs/getting-started). Once you have a MegaNode account and access to the NodeReal Dashboard, you're ready to proceed.
 
@@ -18,11 +21,9 @@ If you haven't signed up for a MegaNode account yet, you can find a step-by-step
 
 To start sending RPC requests on MegaNode, you'll need to create an API Key. This project-based unit is used to manage your API requests, and requires you to input a name for the key and leave any notes you prefer for future reference. Here's how to get started:
 
-:::tip One API key for all chains
-
-With only one API Key, you can request all the chains and networks we support on NodeReal.
-
-:::
+!!! tip One API key for all chains
+    
+    With only one API Key, you can request all the chains and networks we support on NodeReal.
 
 **Get started →** Input an API **Key name** and leave any **notes** you prefer:
 
@@ -32,27 +33,23 @@ After you have created an API Key, you can find a dashboard on the main screen.
 
 ![MegaNode User's Dashboard](https://files.readme.io/b715e5a-Screen_Shot_2023-01-10_at_19.31.18.png)
 
-:::info How many API Keys can I create?
+!!! question "How many API Keys can I create?"
 
-The number of available API Keys is subjected to the pricing plan.
+    The number of available API Keys is subjected to the pricing plan.
 
-:::
-
-### Find Your API Key
+### Find your API key
 
 After you have successfully created an API Key, you can find the API endpoints on the API Key detail page. Please note that this API key is used to identify a particular user and should **NOT** be shared with anyone.
 
 ![Created Your First API key](https://files.readme.io/ce6a39d-Screen_Shot_2023-01-10_at_19.34.38.png)
 
-## Make Your First RPC Request
+## Make your first RPC request
 
 After you find the API Key, you can now start to send RPC requests on MegaNode. Please note that all usage will be calculated on an account basis. You can find our API docs [here](https://docs.nodereal.io/reference). Furthermore, you can find more information about the Compute Unit (CU) usage [here](https://docs.nodereal.io/docs/compute-units-cus) and the account Compute Unit Per Second (CUPS) rate limits [here](https://docs.nodereal.io/docs/cups-rate-limit).
 
-:::info Any concern about your Privacy?
-
-Check out NodeReal [<ins>Privacy Policy</ins>](https://nodereal.io/privacy-policy).
+!!! info "Any concern about your Privacy?"
 
-:::
+    Check out NodeReal [<ins>Privacy Policy</ins>](https://nodereal.io/privacy-policy).
 
 We’ll be using [Web3.js](https://web3js.readthedocs.io/en/v1.8.2/) libraries to make our first RPC request.
 
@@ -69,7 +66,7 @@ yarn init # (or yarn init --yes)
 yarn add web3
 ```
 
-With NPM:
+With npm:
 
 ```bash
 mkdir your-project-name
@@ -132,7 +129,7 @@ yarn add web3
 node index.js
 ```
 
-### Response in Your Terminal
+### Response in Your terminal
 
 You should be able to see the latest block number and block details on your terminal.
 
@@ -141,7 +138,7 @@ Latest block number: 40302452
 Latest block details: {.............}
 ```
 
-### Self-Service Troubleshooting for MegaNode users
+### Self-service troubleshooting for MegaNode users
 
 Please refer to [MegaNode Errors](https://docs.nodereal.io/docs/support) for more information.
 

docs/pos/howto/operating/full-node/ansible.md

@@ -1,8 +1,6 @@
-## Overview of Ansible Playbook Utilization
-
 To configure and effectively manage a Polygon full node, we employ an [Ansible playbook](https://docs.ansible.com/ansible/latest/user_guide/playbooks_intro.html). This tool streamlines the process, ensuring a consistent and error-free setup.
 
-## Prerequisites for Ansible Setup
+## Prerequisites
 
 - **Ansible with Python 3.x**: Your local machine must have Ansible installed with Python version 3.x. Note that Python 2.x is incompatible with this setup. Use the following command to install Ansible using pip (Python's package installer). If pip is not installed, refer to [pip installation guidelines](https://pip.pypa.io/en/stable/):
 
@@ -14,7 +12,7 @@ To configure and effectively manage a Polygon full node, we employ an [Ansible p
 
 - **Environment Setup**: Ensure that Go is not installed on your environment. Ansible requires specific Go packages, and existing installations could lead to conflicts. Additionally, any pre-existing setups of Polygon Validator, Heimdall, or Bor on your VM/machine must be removed to avoid setup conflicts.
 
-## Setting Up the Full Node
+## Setting up the full node
 
 - **Remote Machine Access**: Confirm access to the VM or machine where the full node will be set up. Detailed setup instructions are available at the [node-ansible setup guide](https://github.com/maticnetwork/node-ansible#setup).
 
@@ -74,7 +72,7 @@ To configure and effectively manage a Polygon full node, we employ an [Ansible p
   sudo service bor start
   ```
 
-## Managing Logs and Permissions
+## Managing logs and permissions
 
 - **Logs**: Use `journalctl` for log management. For advanced usage, refer to [this tutorial](https://www.digitalocean.com/community/tutorials/how-to-use-journalctl-to-view-and-manipulate-systemd-logs).
 
@@ -87,7 +85,7 @@ To configure and effectively manage a Polygon full node, we employ an [Ansible p
   sudo chown bor /var/lib/bor
   ```
 
-## Network Security and Port Configuration
+## Network security and port configuration
 
 - **Firewall Setup**: Open ports 22, 26656, and 30303 to all (0.
 

docs/pos/howto/operating/full-node/docker.md

@@ -15,7 +15,7 @@ Summary:
 - Have 2.5 TB to 5 TB of high-speed storage.
 - Use a public IP and open ports 30303 and 26656.
 
-## Initial Setup
+## Initial setup
 
 You should have root-level shell access to a Linux machine.
 
@@ -50,7 +50,7 @@ sudo usermod -aG docker $USER
 
 Logout and log back in to apply these changes.
 
-### Disk Setup
+### Disk setup
 
 The specific steps for disk setup will vary. Typically, you'll have a root partition for the OS and separate devices for blockchain data. For this guide, we'll assume an additional device mounted at `/mnt/data`.
 
@@ -77,7 +77,7 @@ To ensure the device mounts on reboot, add it to `/etc/fstab`:
 
 Reboot to confirm the proper loading of your mount.
 
-### Heimdall Setup
+### Heimdall setup
 
 With Docker running and storage prepared, it's time to set up Heimdall:
 
@@ -166,7 +166,7 @@ Check Bor's sync status with:
 curl 'localhost:8545/' --header 'Content-Type: application/json' -d '{"jsonrpc":"2.0","method":"eth_syncing","params":[],"id":1}'
 ```
 
-### Seed Nodes and Bootnodes
+### Seed nodes and bootnodes
 
 - **Heimdall Seed Nodes**:
 

docs/pos/howto/operating/full-node/gcp.md

@@ -1,6 +1,6 @@
 Deploying Polygon nodes on a Virtual Machine (VM) instance in the Google Cloud Platform (GCP) is a straightforward process. This guide focuses on Ubuntu 20.04, a modern OS with long-term support, but the steps are adaptable to Debian 11 or other similar distributions.
 
-## Deploying a VM Instance on GCP
+## Deploying a VM instance on Google Cloud Platform
 
 To create a VM instance on GCP, you can use either the Google Cloud CLI or the Web Console. This guide will detail the process using the Google Cloud CLI.
 

docs/pos/howto/operating/full-node/index.md

@@ -1,8 +1,6 @@
-# Operating a Polygon Full PoS Node
+Welcome to the guide on setting up your own Polygon full Proof of Stake (PoS) node. Polygon, formerly known as Matic Network, represents a significant advancement in blockchain technology, offering a solution for Ethereum's scalability issues while maintaining its robust security features. By setting up a full PoS node on the Polygon network, you contribute to the network's decentralization, enhancing its security and efficiency.
 
-Welcome to the comprehensive guide on setting up your own Polygon full Proof of Stake (PoS) node. Polygon, formerly known as Matic Network, represents a significant advancement in blockchain technology, offering a solution for Ethereum's scalability issues while maintaining its robust security features. By setting up a full PoS node on the Polygon network, you contribute to the network's decentralization, enhancing its security and efficiency.
-
-### Why Run a Polygon Full PoS Node?
+### Why run a full PoS node?
 
 Running a full PoS node on the Polygon network offers several benefits:
 
@@ -20,7 +18,7 @@ Before diving into the setup process, ensure you have the following:
 - A stable and fast internet connection.
 - Basic knowledge of command-line interface operations and software installation.
 
-### Different Methods for Running a Node
+### Different methods for running a node
 
 This section includes guides for running the node via manual installation of binaries, Docker, Ansible, or Google Cloud Platform. Use the section navigation to peruse the method you prefer.
 

docs/pos/howto/operating/full-node/manual-install.md

@@ -26,7 +26,7 @@ In this section, we will guide you through a sequential process to ensure the su
 
 It is imperative to follow these steps in the given order. Deviating from this sequence can lead to complications and potential issues in the setup and operation of your full PoS node. By adhering to this structured approach, you will ensure a successful and efficient node setup, ready to contribute to the Polygon network.
 
-## Initial Setup: Installing Build Essentials
+## Initial setup
 
 To establish a robust foundation for your Polygon full node, begin by installing `build-essential`. This package is a prerequisite, containing essential tools for compiling and managing your node. Execute the following commands to install it:
 
@@ -35,7 +35,7 @@ sudo apt-get update
 sudo apt-get install build-essential
 ```
 
-## Step-by-Step Installation of Polygon Node Components
+## Installing Polygon node components
 
 Polygon's node architecture is dual-layered, comprising Heimdall and Bor. Heimdall, a Tendermint-based layer, oversees Ethereum contracts, while Bor, derived from Geth, is responsible for block production.
 
@@ -57,7 +57,7 @@ Polygon's node architecture is dual-layered, comprising Heimdall and Bor. Heimda
    heimdalld version --long
    ```
 
-### Configuring Heimdall Seeds
+### Configuring Heimdall seeds
 
 - For **Mainnet**, execute the following commands to configure seeds and set ownership:
 
@@ -91,7 +91,7 @@ Polygon's node architecture is dual-layered, comprising Heimdall and Bor. Heimda
    bor version
    ```
 
-### Configuring Bor Seeds
+### Configuring Bor seeds
 
 - **Mainnet Configuration** involves setting bootnodes and ownership:
 
@@ -111,7 +111,7 @@ Polygon's node architecture is dual-layered, comprising Heimdall and Bor. Heimda
   chown bor /var/lib/bor
   ```
 
-## Update Service Configurations and User Permissions
+## Updating service configuration and user permissions
 
 Adjust user permissions for both Heimdall and Bor services by editing the respective service files:
 
@@ -122,7 +122,7 @@ sed -i 's/User=heimdall/User=root/g' /lib/systemd/system/heimdalld.service
 sed -i 's/User=bor/User=root/g' /lib/systemd/system/bor.service
 ```
 
-## Initiating Services
+## Initiating services
 
 Ensure Heimdall is fully synchronized before launching Bor. Use these commands to start and verify synchronization:
 
@@ -139,7 +139,7 @@ Once Heimdall is synced (catching_up: false), start Bor:
 sudo service bor start
 ```
 
-## Monitoring and Log Management
+## Monitoring and log management
 
 Utilize `journalctl` for log management. Here's how to access logs for Heimdall and Bor:
 
@@ -150,19 +150,9 @@ journalctl -u heimdalld.service -f
 journalctl -u bor.service -f
 ```
 
-## Firewall and Port Configuration
+## Firewall and port configuration
 
 Ensure proper network configuration by opening ports 22, 26656, and 30303. Additionally, consider
 
 VPN options for enhanced security.
 
-## Documentation Summary
-
-This guide provides a structured approach for:
-
-- Preparing your full node machine.
-- Sequential installation and configuration of Heimdall and Bor.
-- Essential post-installation steps and synchronization checks.
-- Best practices for monitoring and maintaining node health.
-
-**Important Reminder**: Adhering to the outlined sequence is critical to avoid potential issues.