docs(maci): updated docs after review

Adjustments to the docs

fix #531 and #556

circuits/README.md

@@ -10,14 +10,17 @@ The main circuits are:
 
 The rest of the circuits are utilities templates that are required for the main circuits to work correctly. These include utilities such as Float math, conversion of private keys, and Poseidon hashing/encryption.
 
-Please refer to the [documentation](https://privacy-scaling-explorations.github.io/maci/circuits.html) for a more in depth explanation
+Please refer to the [documentation](https://privacy-scaling-explorations.github.io/maci/circuits.html) for a more in depth explanation.
 
 ## Testing
 
 In order to test the circuits package follow the instructions below:
 
 1. Configure `circomHelperConfig.json` with the correct path to the circom binary. If installed via `cargo` it will likely be in `~/.cargo/bin/circom`
-2. run `npm run circom-helper` and wait for it to compile all test circuits and expose the JSON API
+2. run `npm run circom-helper` and wait for it to compile all test circuits and expose the JSON API. Please note that this can take around 10 to 15 minutes, depending on the specs of your machine. Once ready, the following will appear on screen:
+    ```
+    Launched JSON-RPC server at port 9001
+    ```
 3. run `npm run test` to run all tests or add `-$CIRCUIT_NAME` to test individually (e.g. `npm run test-processMessages`)
 
 

contracts/README.md

@@ -7,16 +7,16 @@ For more information please refer to the [documentation for Contracts](http://pr
 ## Contracts
 
 * **`MACI.sol`**
-    - The main contract that allows users to sign-up, deploy new Polls, and merge Merkle Trees. 
+    - The main contract that allows users to sign-up, deploy new Polls, and merge Merkle Trees
 
 * **`Polls.sol`**
     - All data pertaining to a poll resides here. It should be deployed via the PollFactory contract
 
 * **`PollFactory`**
-    - Resides inside `Poll.sol` and allows to deploy a new Poll contract.
+    - Resides inside `Poll.sol` and allows to deploy a new Poll contract
 
 * **`DomainObjs.sol`**
-    - Defines `structs` that represent domain objects.
+    - Defines `structs` that represent domain objects
 
 * **`IMACI`**
     - The interface for the MACI contract - describes callable functions
@@ -34,10 +34,10 @@ For more information please refer to the [documentation for Contracts](http://pr
     - A contract holding the verifying keys for the circuits
 
 * **`crypto/`**
-    - Contracts with cryptographic functions including hash functions.
+    - Contracts with cryptographic functions including hash functions
 
 * **`trees/`**
-    - Contains Merkle tree contracts.
+    - Contains Merkle tree contracts
 
 * **`gatekeepers/`**
     - Abstract contract for creating signup gatekeepers and two sample implementations (FreeForAll and SignUpToken gatekeepers)
@@ -46,4 +46,4 @@ For more information please refer to the [documentation for Contracts](http://pr
     - Contains contracts implementations for retrieving voice credits assigned to voters
 
 * **`HasherBenchmarks/`**
-    - Contract with testing and gas benchmark functions only for development purposes.
+    - Contract with testing and gas benchmark functions only for development purposes

docs/README.md

@@ -3,8 +3,6 @@
 Minimum Anti-Collusion Infrastructure (MACI) is a base layer for
 bribery-resistant, secure, and private digital voting.
 
-The documentation here pertains to version 1.2, temporarily located in the `v1` branch.
-
 Applications like [clr.fund](https://clr.fund/) build atop MACI to increase
 privacy and discourage bribery for public goods funding.
 

docs/audit.md

@@ -1,6 +1,6 @@
 # Security Audit 2022 
 
-In the summer of 2022, MACI v1 was audited by Hashcloak. The audit covered both the zk-SNARK circuits and the Solidity smart contracts.
+In the summer of 2022, MACI v1 was audited by HashCloak. The audit covered both the zk-SNARK circuits and the Solidity smart contracts.
 
 This audited revealed a number of high severity issues which have been remediated by the MACI development team. We will be looking at those in details in the following sections.
 
@@ -92,4 +92,4 @@ function deployPoll(
 
 As seen above, an external call is made, before updating the state with the new poll. The issue is tracked [here](https://github.com/privacy-scaling-explorations/maci/pull/522#discussion_r981863147) and only left open as the code does not enforce best practices, however it does not pose any immediate risk. 
 
-The rest of the issues were succesffuly fixed and merged in the v1 branch.
+The rest of the issues were succesffuly fixed and reflected in the v1.1.1. For the full report, please refer to the `audit` folder inside the root of the repository.