Merge pull request 0xPolygon#384 from 0xPolygon/pos-enable-comments

hsutaiyu · web-flow · commit b631553fbb25 · 2024-04-23T17:51:45.000+04:00
PoS: enable comments on 24 pages
diff --git a/docs/pos/get-started/becoming-a-validator.md b/docs/pos/get-started/becoming-a-validator.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 Validators are the key actor in maintaining the Polygon network. Validators run a full node, secure the network by staking MATIC to produce blocks, validate and participate in PoS consensus.
 
 !!!info
diff --git a/docs/pos/get-started/building-on-polygon.md b/docs/pos/get-started/building-on-polygon.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 Ethereum developers are by default Polygon developers. Welcome. Simply switch to the [Polygon RPC](https://polygon-rpc.com/) and get started. All familiar tools used on Ethereum are supported on Polygon. Whether it is Truffle, Remix or Web3.js, Polygon offers the same UX as Ethereum.
 
 Connect your wallet and deploy any decentralized application to either Polygon Mainnet or Polygon Mumbai Testnet.
diff --git a/docs/pos/how-to/access-node.md b/docs/pos/how-to/access-node.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 If you're a new Web3 developer, it's unlikely that you'll need to run your own full node on Polygon.
 
 The majority of developers use a node provider, or a third-party external service that receives node requests and returns responses for you automatically. That's because the fastest way to get developing on Polygon is using a node provider rather than managing your own node.
diff --git a/docs/pos/how-to/bridging/ethereum-polygon/ethereum-to-matic.md b/docs/pos/how-to/bridging/ethereum-polygon/ethereum-to-matic.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 The mechanism to natively read Ethereum data from Polygon EVM chain is that of ‘State Sync’. In other words, this mechanism enables transfer of arbitrary data from Ethereum chain to Polygon chain. The procedure that makes it possible is: Validators on the Heimdall layer are listening for a particular event — `StateSynced` from a Sender contract, as soon as the event is picked, the `data` that was passed in the event is written on the Receiver contract. Read more [here](../../../architecture/bor/state-sync.md).
 
 The Sender and Receiver contract are required to be mapped on Ethereum — [StateSender.sol](https://github.com/maticnetwork/contracts/blob/release-betaV2/contracts/root/stateSyncer/StateSender.sol) needs to be aware of each sender and receiver.
diff --git a/docs/pos/how-to/bridging/ethereum-polygon/matic-to-ethereum.md b/docs/pos/how-to/bridging/ethereum-polygon/matic-to-ethereum.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 Mechanism for transferring data from Polygon to Ethereum is a little different from doing the same for Ethereum to Polygon. The **checkpoint** transactions created by the Validators on the Ethereum chain are used for achieving this. Basically a transaction is initially created on Polygon. While creating this transaction it has to be ensured that an **event is emitted** and the **event logs includes the data we wish to transfer** from Polygon to Ethereum.
 
 In a period of time ( about 10-30 mins ), this transaction is check-pointed on the Ethereum chain by the validators. Once checkpointing is done, the hash of the transaction created on the Polygon chain can be submitted as a proof on the **RootChainManager** contract on the Ethereum chain. This contract, validates the transaction, verifies that this transaction is included in the checkpoint and finally decodes the event logs from this transaction.
diff --git a/docs/pos/how-to/bridging/ethereum-polygon/submit-mapping-request.md b/docs/pos/how-to/bridging/ethereum-polygon/submit-mapping-request.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 Token mapping is important in order to enable the transfer mechanism for the said token between Ethereum and Polygon PoS.
 
 !!! info
diff --git a/docs/pos/how-to/bridging/l1-l2-communication/state-transfer.md b/docs/pos/how-to/bridging/l1-l2-communication/state-transfer.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 Polygon validators continuously monitor a contract on Ethereum chain called `StateSender`. Each time a registered contract on Ethereum chain calls this contract, it emits an event. Using this event Polygon validators relay the data to another contract on Polygon chain. This **State Sync** mechanism is used to send data from Ethereum to Polygon.
 
 Additionally, Polygon validators send an Ethereum hash of each transaction on the Polygon chain on a regular basis. You can use this **checkpoint** to validate any transaction that took place on Polygon. Once a transaction has been verified to have occurred on the Polygon chain, Ethereum can then be used to carry out the appropriate action.
diff --git a/docs/pos/how-to/delegate.md b/docs/pos/how-to/delegate.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 
 # How to delegate
 
diff --git a/docs/pos/how-to/erigon-archive-node.md b/docs/pos/how-to/erigon-archive-node.md
@@ -1,3 +1,6 @@
+---
+comments: true
+---
 
 ## System requirements
 
diff --git a/docs/pos/how-to/full-node/full-node-ansible.md b/docs/pos/how-to/full-node/full-node-ansible.md
@@ -1,3 +1,6 @@
+---
+comments: true
+---
 
 An [Ansible playbook](https://docs.ansible.com/ansible/latest/user_guide/playbooks_intro.html) is used to
 configure and manage a full node. 
diff --git a/docs/pos/how-to/full-node/full-node-binaries.md b/docs/pos/how-to/full-node/full-node-binaries.md
@@ -1,3 +1,6 @@
+---
+comments: true
+---
 
 This deployment guide walks you through starting and running a full node through various methods. For the system requirements, see the [minimum technical requirements](../validator/validator-system-requirements.md) guide.
 
diff --git a/docs/pos/how-to/full-node/full-node-docker.md b/docs/pos/how-to/full-node/full-node-docker.md
@@ -1,3 +1,6 @@
+---
+comments: true
+---
 
 The Polygon team distributes official Docker images which can be used to run nodes on the Polygon Mainnet. These instructions are for running a Full Node, but they can be adapted for running sentry nodes and validators as well.
 
diff --git a/docs/pos/how-to/full-node/full-node-gcp.md b/docs/pos/how-to/full-node/full-node-gcp.md
@@ -1,3 +1,6 @@
+---
+comments: true
+---
 
 In this document, we will describe how to deploy Polygon nodes into a Virtual Machine instance on the Google Cloud Platform (GCP).
 
diff --git a/docs/pos/how-to/full-node/full-node-packages.md b/docs/pos/how-to/full-node/full-node-packages.md
@@ -1,3 +1,6 @@
+---
+comments: true
+---
 
 ## Overview
 
diff --git a/docs/pos/how-to/operate-validator-node/topup-heimdall-fee.md b/docs/pos/how-to/operate-validator-node/topup-heimdall-fee.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 
 This document provides instructions on how to top up the Heimdall fee for a PoS Validator. 
 
diff --git a/docs/pos/how-to/operate-validator-node/validator-staking-operations.md b/docs/pos/how-to/operate-validator-node/validator-staking-operations.md
@@ -1,3 +1,6 @@
+---
+comments: true
+---
 
 ## Prerequisites
 
diff --git a/docs/pos/how-to/polygon-did.md b/docs/pos/how-to/polygon-did.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 This is a startup guide for users who wish to use the implementation packages published by Polygon team, to generate and publish a Polygon DID on the Polygon ledger.
 
 The Polygon DID method Implementation comprises of 3 packages, namely the polygon-did-registrar, polygon-did-resolver and polygon-did-registry-contract. A user who wants to incorporate the functionality to either register or read a DID on or from Polygon network can use the following guide.
diff --git a/docs/pos/how-to/snapshots.md b/docs/pos/how-to/snapshots.md
@@ -1,3 +1,7 @@
+---
+comments: true
+---
+
 When setting up a new sentry, validator, or full node server, it is recommended that you use snapshots for faster syncing without having to sync over the network. Using snapshots will save you several days for both Heimdall and Bor. 
 
 !!! note
diff --git a/docs/pos/how-to/troubleshoot/known-issues.md b/docs/pos/how-to/troubleshoot/known-issues.md
@@ -1,3 +1,6 @@
+---
+comments: true
+---
 
 ### Error: Bad block/Invalid Merkle
 
diff --git a/docs/pos/how-to/validator/prerequisites.md b/docs/pos/how-to/validator/prerequisites.md
@@ -1,3 +1,6 @@
+---
+comments: true
+---
 
 ## Before setting up the Validator node
 
diff --git a/docs/pos/how-to/validator/validator-ansible.md b/docs/pos/how-to/validator/validator-ansible.md
@@ -1,3 +1,6 @@
+---
+comments: true
+---
 
 This section guides you through starting and running the validator node through an Ansible playbook.
 
diff --git a/docs/pos/how-to/validator/validator-binaries.md b/docs/pos/how-to/validator/validator-binaries.md
@@ -1,3 +1,6 @@
+---
+comments: true
+---
 
 This guide will walk you through running a Polygon validator node from packages.
 
diff --git a/docs/pos/how-to/validator/validator-packages.md b/docs/pos/how-to/validator/validator-packages.md
@@ -1,3 +1,6 @@
+---
+comments: true
+---
 
 ## Prerequisites
 
diff --git a/docs/pos/reference/rpc-endpoints.md b/docs/pos/reference/rpc-endpoints.md
@@ -1,4 +1,8 @@
-This guide provides an index of network details for the Polygon Mumbai Testnet and Polygon PoS Mainnet, including their associated RPC and node endpoints.
+---
+comments: true
+---
+
+This guide provides an index of network details for the Polygon Amoy testnet and Polygon PoS mainnet, including their associated RPC and node endpoints.
 
 ## Network details
 

-Original file line number
+Diff line change
@@ @@ -1,3 +1,7 @@ @@
 +---
 +comments: true
 +---
++
 Validators are the key actor in maintaining the Polygon network. Validators run a full node, secure the network by staking MATIC to produce blocks, validate and participate in PoS consensus.
 !!!info