zkevm style check

Author: kmurphypolygon

docs/zkEVM/get-started/deploy-zkevm/configure-prover.md

@@ -28,7 +28,7 @@ GRANT ALL PRIVILEGES ON TABLE state.program TO prover_user;
 
 Save and exit the file once the changes have been made. The above SQL script will set up your databases for the zkEVM Node.
 
-## Configure the prover
+## Configure the Prover
 
 Create the `~/zkevm/config.json` and paste the configs below. Replace the `aggregatorClientHost` parameter with your **PUBLIC IP**:
 
@@ -650,7 +650,7 @@ docker compose --env-file $ZKEVM_CONFIG_DIR/.env -f $ZKEVM_DIR/$ZKEVM_NET/docker
 docker compose --env-file $ZKEVM_CONFIG_DIR/.env -f $ZKEVM_DIR/$ZKEVM_NET/docker-compose.yml logs -f zkevm-state-db
 ```
 
-### Start the prover (contains executor)
+### Start the Prover (contains executor)
 
 ```bash
 export ZKEVM_NET="mainnet"

docs/zkEVM/get-started/deploy-zkevm/index.md

@@ -8,13 +8,13 @@ However, in order to allow for in-between breaks, the process is aesthetically s
 
 - [**Second step**](install-dependencies.md): Installing dependencies and downloading mainnet files.
 
-- [**Third step**](create-wallets.md): Creating wallets and deploying Contracts.
+- [**Third step**](create-wallets.md): Creating wallets and deploying contracts.
 
 - [**Fourth step**](deploy-zknode.md): Deployment of the zkNode.
 
-- [**Fifth step**](configure-prover.md): Configuring the Prover and Services.
+- [**Fifth step**](configure-prover.md): Configuring the Prover and services.
 
-- [**Sixth step**](setup-goerli-node.md): Activating forced txs and Bridging/claiming Assets.
+- [**Sixth step**](setup-goerli-node.md): Activating forced txs and bridging/claiming assets.
 
 !!!caution
     Instructions in this document are subject to frequent updates as the zkEVM software is still in early development stages.
@@ -25,9 +25,9 @@ However, in order to allow for in-between breaks, the process is aesthetically s
 
 Implementing the full stack Polygon zkEVM involves more than just running an RPC zkNode or the Prover to validate batches, and deploying Smart Contracts. In its entirety, it encompasses all these processes and more.
 
-The common rollup actors, mainly from the zkNode view, are the **Sequencer**, the **Aggregator**, the **Synchroniser** and the JSON **RPC** node. All these affect the L2 **State**.
+The common rollup actors, mainly from the zkNode view, are the Sequencer, the Aggregator, the Synchroniser and the JSON RPC node. All these affect the L2 State.
 
-Also, the Aggregator uses the **Prover** to avail verifiable proofs of sequenced batches. And the sequenced batches are composed of transactions taken from the **Pool DB**.
+Also, the Aggregator uses the Prover to avail verifiable proofs of sequenced batches. And the sequenced batches are composed of transactions taken from the Pool DB.
 
 This highlights just a few main components. The rest of the zkEVM components and those working in the background, are listed in the next subsection.
 
@@ -70,14 +70,14 @@ Since the zkEVM implementation involves running Docker containers, ensure that a
 
 Here's how to get setup;
 
-For _Linux machines_, Install **Docker engine** directly on the machine.
+For Linux machines, install the Docker engine directly on the machine.
 
-For other _Operating Systems_ (MacOS, Windows), this is achieved in 4 steps, executed in the given sequential order;
+For other Operating Systems (MacOS, Windows), this is achieved in 4 steps, executed in the given sequential order;
 
-- Install a **Hypervisor**. (e.g., VirtualBox, VMware Fusion (MacOS), VMware Workstation (Windows), VMware ESXi (Bare Metal Hypervisor)).
-- Setup a **Virtual machine**. (e.g., If you are using VirtualBox, which is open-source, Vagrant is the quickest way to automatically setup a virtual machine and also set up ssh private/public keys.)
-- Install **Linux** as Guest OS, preferably the latest version of Ubuntu Linux.
-- Install [**Docker**](https://docs.docker.com/desktop/install/linux-install/).
+- Install a hypervisor, e.g., VirtualBox, VMware Fusion (MacOS), VMware Workstation (Windows), VMware ESXi (Bare Metal Hypervisor).
+- Setup a virtual machine, e.g., if you are using VirtualBox, which is open-source, Vagrant is the quickest way to automatically setup a virtual machine and also set up ssh private/public keys.
+- Install Linux as Guest OS, preferably the latest version of Ubuntu Linux.
+- Install [Docker](https://docs.docker.com/desktop/install/linux-install/).
 
 Search the internet for quick guides on creating virtual machines. Here's an example of a video on [How to Create a Linux Virtual Machine on a Mac](https://www.youtube.com/watch?v=KAd7FafXfJQ).
 
@@ -94,8 +94,8 @@ Next, ensure that you have checked your system specs, and have at hand all the v
 
 You'll need the following items to begin:
 
-- INFURA_PROJECT_ID // Same as API Key in your Infura account
-- ETHERSCAN_API_KEY
+- `INFURA_PROJECT_ID` // Same as API Key in your Infura account
+- `ETHERSCAN_API_KEY`
 - Public IP address
 - L1 Goërli node RPC
 - Goërli address with **0.5 GöETH**
@@ -108,28 +108,28 @@ Keep in mind that the mainnet files you will be downloading are 70GB big.
 
 If the Prover is the only container you will be running externally in a cloud, then it is preferable to have a minimum 300GB of storage in the primary machine.
 
-Depending on the user's resources, the zkEVM network can be implemented with either the actual _full prover_ or the _mock prover_.
+Depending on the user's resources, the zkEVM network can be implemented with either the actual full prover or the mock prover.
 
-The full prover is resource-intensive as it utilises the exact same proving stack employed in the real and live zkEVM network.
+The full prover is resource-intensive as it utilizes the exact same proving stack employed in the real and live zkEVM network.
 
 !!!info
-    The **full prover**'s system requirements are:
+    The full Prover's system requirements are:
 
     - 96-core CPU
     - Minimum 768GB RAM
 
 The Mock Prover is a dummy prover which simply adds a "Valid ✅" checkmark to every batch.
 
 !!!info
-    The **mock prover**, on the other hand only requires:
+    The mock Prover, on the other hand, only requires:
 
     - 4-core CPU
     - 8GB RAM (16GB recommended)
 
 As an example, the equivalent [AWS EC2s](https://aws.amazon.com/ec2/instance-types/r6a/) for each of these two provers are as follows:
 
-- r6a.xlarge for **mock prover**
-- r6a.24xlarge for **full prover**
+- r6a.xlarge for mock Prover
+- r6a.24xlarge for full Prover
 
 The initial free disk space requirement is minimal (<2TB), but you should monitor available space as the network is always adding more data.
 

docs/zkEVM/get-started/deploy-zkevm/install-dependencies.md

@@ -1,5 +1,5 @@
 
-Continue with the **second step** of this deployment-guide where you install dependencies and download Mainnet files.
+Continue with the **second step** of this deployment-guide where you install dependencies and download mainnet files.
 
 ## Install dependencies
 

docs/zkEVM/get-started/index.md

@@ -9,4 +9,4 @@ Users do not need any special toolings or wallets in order to build or interact
 Simply switch to the zkEVM RPC and start building on a network with a higher throughput and lower fees.
 
 !!!caution
-    Check the list of potential risks associated with the use of Polygon zkEVM in the [Disclosures]() section.
+    Check the list of potential risks associated with the use of Polygon zkEVM in the [Disclosures](../troubleshooting/risk-disclosures.md) section.

docs/zkEVM/get-started/quick-start/bridge-to-zkevm.md

@@ -1,6 +1,6 @@
 
 !!!caution
-    Check the list of potential risks associated with the use of Polygon zkEVM in the [Disclosures]() section.
+    Check the list of potential risks associated with the use of Polygon zkEVM in the [Disclosures](../../troubleshooting/risk-disclosures.md) section.
 
 Users can deposit assets from Ethereum and transact off-chain on Polygon zkEVM. For moving assets across chains (L1 ↔ zkEVM), you will need to use the zkEVM Bridge. The bridge interface is available for both Mainnet Beta and Testnet in the [Polygon Wallet Suite](https://wallet.polygon.technology/zkEVM/bridge).
 
@@ -11,7 +11,7 @@ The next video is a guide on how to bridge tokens from L1 to the zkEVM Testnet.
   <p>Your browser does not support the video element.</p>
 </video>
 
-## Step-by-Step Guide
+## Step-by-step guide
 
 Follow this step-by-step guide on how to bridge assets from Ethereum to Polygon zkEVM Mainnet and vice-versa. Or, from an Ethereum testnet to zkEVM testnet, and conversely.
 
@@ -26,14 +26,14 @@ Follow this step-by-step guide on how to bridge assets from Ethereum to Polygon
 ![Figure: bridge2](../../../img/zkEVM/zkv-bridge2.jpg)
 
 - Recent transactions and pending transactions can be viewed on the right hand side of the page.
-- Click the `Bridge ETH to zkEVM testnet` button to proceed. This is followed by Metamask's prompt to approve gas to be spent.
+- Click the **Bridge ETH to zkEVM testnet** button to proceed. This is followed by Metamask's prompt to approve gas to be spent.
 
 ![Figure: metamask1](../../../img/zkEVM/zkv-metamask1.jpg)
 
-- Click `Confirm` to approve the bridge transaction.
+- Click **Confirm** to approve the bridge transaction.
 
 - And allow a few moments for your transaction to be processed.
 
-- Once it is completed, past and pending transactions can be viewed by clicking the "Transactions" button located on the left side of the menu.
+- Once it is completed, past and pending transactions can be viewed by clicking the **Transactions** button located on the left side of the menu.
 
 ![Figure: tx-history](../../../img/zkEVM/zkv-transaction-history.jpg)

docs/zkEVM/get-started/quick-start/connect-wallet.md

@@ -1,10 +1,9 @@
-
 !!!caution
-    Check the list of potential risks associated with the use of Polygon zkEVM in the [Disclosures]() section.
+    Check the list of potential risks associated with the use of Polygon zkEVM in the [Disclosures](../../troubleshooting/risk-disclosures.md) section.
 
 Connect to either the Polygon zkEVM's mainnet or the testnet. 
 
-Add the Polygon zkEVM network of your choice to your wallet by navigating to `Add network`, and enter the respective network details as given in the below table:
+Add the Polygon zkEVM network of your choice to your wallet by navigating to the add network input, and enter the respective network details as given in the below table:
 
 | Network | RPC URL | ChainID | Block Explorer URL | Currency |
 | ------- | ------------------------------- | ---------------- | ---------------- | ----- |

docs/zkEVM/get-started/quick-start/zkevm-faucet.md

@@ -1,6 +1,5 @@
-
 !!!caution
-    Check the list of potential risks associated with the use of Polygon zkEVM in the [Disclosures]() section.
+    Check the list of potential risks associated with the use of Polygon zkEVM in the [Disclosures](../../troubleshooting/risk-disclosures.md) section.
 
 Polygon faucet is the official tool provided by Polygon Labs to obtain Testnet tokens. It is a faucet that is similar to what ecosystem partners like Alchemy provide.
 
@@ -20,11 +19,11 @@ Here is how to use the Polygon zkEVM faucet:
 
 - Select the type of Testnet token that you want to receive. In our case, we only have the option to receive **zkEVM ETH** which is also the default option.
 
-- Enter your **wallet address** (you can copy it from your MetaMask or any wallet that supports testnet tokens)
+- Enter your **wallet address** (you can copy it from your MetaMask or any wallet that supports testnet tokens).
 
-- Click on the **Submit** button to send your token request
+- Click on the **Submit** button to send your token request.
 
-- Click **Confirm** to finalize the transaction
+- Click **Confirm** to finalize the transaction.
 
 ![Figure: confirm-tx](../../../img/zkEVM/zkv-confirm-zketh.png)
 

docs/zkEVM/get-started/setup-nodes/local-node.md

@@ -11,11 +11,11 @@ This tutorial is a guide to setting up a local but single zkEVM node. It is _sin
 
 At the end of this tutorial, the following components will be running:
 
-- zkEVM Node Databases
-- Explorers and their Databases
-- L1 Network
-- Prover
-- zkEVM Node components
+- zkEVM node databases.
+- Explorers and their databases.
+- L1 network.
+- Prover.
+- zkEVM node components.
 
 ## Prerequisites
 
@@ -27,10 +27,10 @@ The tutorial for current version of the environment requires `go`, `docker` and
 
 ### System requirements
 
-- zkEVM Node: 16GB RAM with 4-core CPU
-- zkProver: 1TB RAM with 128-core CPU
+- zkEVM Node: 16GB RAM with 4-core CPU.
+- zkProver: 1TB RAM with 128-core CPU.
 
-Running a full-fledged zkProver requires at least 1TB of RAM. However, users with less memory can opt to use the Mock Prover.
+Running a full-fledged zkProver requires at least 1TB of RAM. However, users with less memory can opt to use the mock Prover.
 
 ## Setting up zkNode
 
@@ -51,7 +51,7 @@ The image is built only once and whenever the code has changed.
 !!!caution Building Docker Image
     Every testnet version needs to use configuration files from the correct and corresponding tag. For instance: Make sure to use configuration files from RC9 tag in order to build an RC9 image.
 
-    All tags can be found here: **https://github.com/0xPolygonHermez/zkevm-node/tags**
+    All tags can be found here: https://github.com/0xPolygonHermez/zkevm-node/tags.
 
 Certain commands on the `zkevm-node` can interact with smart contracts, run specific components, create encryption files, and print debug information.
 
@@ -115,30 +115,30 @@ make deploy-uniswap
 make run-approve-matic
 ```
 
-## Connecting to Metamask
+## Connecting to MetaMask
 
 !!!info
     Metamask requires the network to be running while configuring it, so make sure your network is up.
 
 MetaMask can be configured to use the local zkEVM environment by following the steps below:
 
-1. Log in to your MetaMask wallet
-2. Click on your account picture and then on **Settings**
-3. On the left menu, click on **Networks**
-4. Click on **Add Network** button
-5. Fill up the L2 network information
+1. Log in to your MetaMask wallet.
+2. Click on your account picture and then on **Settings**.
+3. On the left menu, click on **Networks**.
+4. Click on **Add Network** button.
+5. Fill up the L2 network information:
     - **Network Name:** Polygon zkEVM - Local
     - **New RPC URL:** <http://localhost:8123>
     - **ChainID:** 1001
     - **Currency Symbol:** ETH
     - **Block Explorer URL:** <http://localhost:4000>
-6. Click on **Save**
-7. Click on **Add Network** button
-8. Fill up the L1 network information
+6. Click on **Save**.
+7. Click on **Add Network** button.
+8. Fill up the L1 network information:
     - **Network Name:** Geth - Local
     - **New RPC URL:** <http://localhost:8545>
     - **ChainID:** 1337
     - **Currency Symbol:** ETH
-9. Click on **Save**
+9. Click on **Save**.
 
 You can now interact with your local zkEVM network and sign transactions from your MetaMask wallet.