docs(docs): added comments

privacy-scaling-explorations · Jun 11, 2024 · 4c6a90f · 4c6a90f
1 parent 2c244ef
commit 4c6a90f
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/...ed_docs/version-v2.0_alpha/developers-references/smart-contracts/Gatekeepers.md b/...ed_docs/version-v2.0_alpha/developers-references/smart-contracts/Gatekeepers.md
@@ -16,7 +16,7 @@ The MACI repository comes with several out-of-the-box options:
 - `EASGatekeeper` - This restricts signups only to users who have received an attestation of a specific schema from a trusted attester.
 - `HatsGatekeeper` - This allows gatekeeping signups to only users who have a specific [Hat](https://www.hatsprotocol.xyz/).
 - `GitcoinPassportGatekeeper` - This allows gatekeeping signups to only users who have a specific [Gitcoin Passport](https://passport.gitcoin.co/) score.
-- `ZupassGatekeeper` - This allows gatekeeping signups only to users who have a valid Zupass PCD ticket.
+- `ZupassGatekeeper` - This allows gatekeeping signups only to users who have a valid [Zupass PCD ticket](https://github.com/proofcarryingdata/zupass).
 
 You can find all of our latest gatekeeper contracts here:
 https://github.com/privacy-scaling-explorations/maci/tree/dev/contracts/contracts/gatekeepers

diff --git a/website/versioned_docs/version-v2.0_alpha/quick-start/deployment.md b/website/versioned_docs/version-v2.0_alpha/quick-start/deployment.md
@@ -38,7 +38,7 @@ Please do not use test artifacts in production. If you do require zKeys configur
 
 MACI uses a "gatekeeper" contract to configure and enforce the eligibility criteria of voters who can participate in MACI polls. In other words, it is a way to allowlist signups to the system. Operators of MACI can use the gatekeeper contract to configure signup eligibility and to protect against sybil attacks in their polls.
 
-It's necessary to define which gatekeeper are you going to use before deploying, please refer to the [gatekeepers page](/docs/developers-references/smart-contracts/Gatekeepers) section for more information on the supported Gatekeepers.
+It's necessary to define which gatekeeper you are going to use before deploying, please refer to the [gatekeepers section](/docs/developers-references/smart-contracts/Gatekeepers) for more information on the supported Gatekeepers.
 
 ### Deployment using `maci-contracts` hardhat tasks
 

diff --git a/website/versioned_docs/version-v2.0_alpha/quick-start/poll-finalization.md b/website/versioned_docs/version-v2.0_alpha/quick-start/poll-finalization.md
@@ -21,7 +21,7 @@ pnpm run prove:[network] --poll 0 \
 ```
 
 :::info
-If the poll was configured to use quadratic voting, please ensure your prove command has the flag `--use-quadratic-voting`. Omitting the flag will make it work with non quadratic voting only. We also suggest including the `--start-block` flag so the proving doesn't start from block 0.
+If the poll was configured to use quadratic voting, please ensure your prove command has the flag `--use-quadratic-voting`. Omitting the flag will make it work with non quadratic voting only. We also suggest including the `--start-block` flag, proving requires fetching all events from the smartcontract and by default starts from block zero, this would take a lot of time and is error-prone due to RPC provider limitations.
 :::
 
 The network options are: **_localhost, sepolia, and optimism-sepolia_**, and the tasks flags and parameters are as follows:
-Original file line number
+Diff line change
@@ Expand Up / @@ -21,7 +21,7 @@ pnpm run prove:[network] --poll 0 \ @@
     ```
     :::info
-    If the poll was configured to use quadratic voting, please ensure your prove command has the flag `--use-quadratic-voting`. Omitting the flag will make it work with non quadratic voting only. We also suggest including the `--start-block` flag so the proving doesn't start from block 0.
+    If the poll was configured to use quadratic voting, please ensure your prove command has the flag `--use-quadratic-voting`. Omitting the flag will make it work with non quadratic voting only. We also suggest including the `--start-block` flag, proving requires fetching all events from the smartcontract and by default starts from block zero, this would take a lot of time and is error-prone due to RPC provider limitations.
     :::
     The network options are: **_localhost, sepolia, and optimism-sepolia_**, and the tasks flags and parameters are as follows:
@@ Expand Down @@