From 462436070d021994cd8cf3f4618125526fd82bb3 Mon Sep 17 00:00:00 2001 From: Sam Richards Date: Mon, 26 Feb 2024 12:32:55 -0600 Subject: [PATCH] docs: update sidebar indexes --- website/versioned_docs/version-v1.x/audit.md | 2 +- website/versioned_docs/version-v1.x/ci-pipeline.md | 2 +- website/versioned_docs/version-v1.x/circuits.md | 2 +- website/versioned_docs/version-v1.x/cli.md | 2 +- website/versioned_docs/version-v1.x/contracts.md | 2 +- .../version-v1.x/contributing/contributing.md | 2 +- .../version-v1.x/coordinator-processing.md | 2 +- website/versioned_docs/version-v1.x/installation.md | 2 +- website/versioned_docs/version-v1.x/integrating.md | 2 +- website/versioned_docs/version-v1.x/key-change.md | 2 +- website/versioned_docs/version-v1.x/overview.md | 2 +- website/versioned_docs/version-v1.x/primitives.md | 2 +- website/versioned_docs/version-v1.x/purpose.md | 12 +++++++----- website/versioned_docs/version-v1.x/spec.md | 2 +- .../versioned_docs/version-v1.x/testing-in-detail.md | 2 +- website/versioned_docs/version-v1.x/testing.md | 2 +- website/versioned_docs/version-v1.x/topup.md | 2 +- .../versioned_docs/version-v1.x/troubleshooting.md | 2 +- website/versioned_docs/version-v1.x/trusted-setup.md | 2 +- website/versioned_docs/version-v1.x/versioning.md | 2 +- website/versioned_docs/version-v1.x/workflow.md | 2 +- 21 files changed, 27 insertions(+), 25 deletions(-) diff --git a/website/versioned_docs/version-v1.x/audit.md b/website/versioned_docs/version-v1.x/audit.md index bdfa114350..08842a6064 100644 --- a/website/versioned_docs/version-v1.x/audit.md +++ b/website/versioned_docs/version-v1.x/audit.md @@ -2,7 +2,7 @@ title: MACI Security Audits description: Overview of MACI audit history with references to audit reports. sidebar_label: Security audits -sidebar_position: 12 +sidebar_position: 14 --- # MACI Security Audits diff --git a/website/versioned_docs/version-v1.x/ci-pipeline.md b/website/versioned_docs/version-v1.x/ci-pipeline.md index 27e3e6d5d9..b2203e4a49 100644 --- a/website/versioned_docs/version-v1.x/ci-pipeline.md +++ b/website/versioned_docs/version-v1.x/ci-pipeline.md @@ -2,7 +2,7 @@ title: CI Pipeline description: Introduction to how MACI's CI works sidebar_label: CI -sidebar_position: 13 +sidebar_position: 15 --- # Continuous Integration (CI) Pipeline diff --git a/website/versioned_docs/version-v1.x/circuits.md b/website/versioned_docs/version-v1.x/circuits.md index 5fd83e8fdd..bb675327f3 100644 --- a/website/versioned_docs/version-v1.x/circuits.md +++ b/website/versioned_docs/version-v1.x/circuits.md @@ -2,7 +2,7 @@ title: MACI Circuits description: Introduction to the core zk-SNARK circuits of MACI sidebar_label: Circuits -sidebar_position: 7 +sidebar_position: 9 --- # zk-SNARKS in MACI diff --git a/website/versioned_docs/version-v1.x/cli.md b/website/versioned_docs/version-v1.x/cli.md index 2ef755d397..882885d0ee 100644 --- a/website/versioned_docs/version-v1.x/cli.md +++ b/website/versioned_docs/version-v1.x/cli.md @@ -2,7 +2,7 @@ title: MACI Command-line interface (CLI) description: Introduction to the MACI CLI interface that allows for effective deployment and testing sidebar_label: Command-line interface -sidebar_position: 5 +sidebar_position: 7 --- # Command-line interface diff --git a/website/versioned_docs/version-v1.x/contracts.md b/website/versioned_docs/version-v1.x/contracts.md index c4b35a27b4..fcc8c1c4e8 100644 --- a/website/versioned_docs/version-v1.x/contracts.md +++ b/website/versioned_docs/version-v1.x/contracts.md @@ -2,7 +2,7 @@ title: MACI Smart Contracts description: MACI is composed of multiple smart contracts, which together with the zk-SNARK circuits, can be used to carry out on-chain voting sidebar_label: Smart Contracts -sidebar_position: 6 +sidebar_position: 8 --- # Smart Contracts diff --git a/website/versioned_docs/version-v1.x/contributing/contributing.md b/website/versioned_docs/version-v1.x/contributing/contributing.md index 6e3dc25b3c..138f906839 100644 --- a/website/versioned_docs/version-v1.x/contributing/contributing.md +++ b/website/versioned_docs/version-v1.x/contributing/contributing.md @@ -2,7 +2,7 @@ title: Contributing to MACI description: Instructions on how to contribute to MACI sidebar_label: Contributing -sidebar_position: 19 +sidebar_position: 21 --- # Contributing diff --git a/website/versioned_docs/version-v1.x/coordinator-processing.md b/website/versioned_docs/version-v1.x/coordinator-processing.md index 9c17725830..24a56dccc4 100644 --- a/website/versioned_docs/version-v1.x/coordinator-processing.md +++ b/website/versioned_docs/version-v1.x/coordinator-processing.md @@ -2,7 +2,7 @@ title: Coordinator local processing description: How does the coordinator process and tallies messages locally sidebar_label: Coordinator local processing -sidebar_position: 14 +sidebar_position: 16 --- # Coordinator local processing diff --git a/website/versioned_docs/version-v1.x/installation.md b/website/versioned_docs/version-v1.x/installation.md index 0fbead2436..d17478b48e 100644 --- a/website/versioned_docs/version-v1.x/installation.md +++ b/website/versioned_docs/version-v1.x/installation.md @@ -2,7 +2,7 @@ title: Installing MACI description: How to install MACI sidebar_label: Installation -sidebar_position: 4 +sidebar_position: 5 --- # Installation diff --git a/website/versioned_docs/version-v1.x/integrating.md b/website/versioned_docs/version-v1.x/integrating.md index 5b9ea5a73a..1448892c38 100644 --- a/website/versioned_docs/version-v1.x/integrating.md +++ b/website/versioned_docs/version-v1.x/integrating.md @@ -2,7 +2,7 @@ title: Integrating MACI description: How to integrate MACI into your application sidebar_label: Integrating -sidebar_position: 11 +sidebar_position: 13 --- # Integrating MACI diff --git a/website/versioned_docs/version-v1.x/key-change.md b/website/versioned_docs/version-v1.x/key-change.md index 4a81356454..dbae3e7f08 100644 --- a/website/versioned_docs/version-v1.x/key-change.md +++ b/website/versioned_docs/version-v1.x/key-change.md @@ -2,7 +2,7 @@ title: MACI key change description: How key change messages work sidebar_label: Key change -sidebar_position: 16 +sidebar_position: 18 --- # MACI Key Change diff --git a/website/versioned_docs/version-v1.x/overview.md b/website/versioned_docs/version-v1.x/overview.md index a82d816a4d..b549eba010 100644 --- a/website/versioned_docs/version-v1.x/overview.md +++ b/website/versioned_docs/version-v1.x/overview.md @@ -2,7 +2,7 @@ title: MACI Overview description: High-level overview of the MACI codebase sidebar_label: Overview -sidebar_position: 3 +sidebar_position: 4 --- # MACI Overview diff --git a/website/versioned_docs/version-v1.x/primitives.md b/website/versioned_docs/version-v1.x/primitives.md index a9e15c414f..49fe77027f 100644 --- a/website/versioned_docs/version-v1.x/primitives.md +++ b/website/versioned_docs/version-v1.x/primitives.md @@ -2,7 +2,7 @@ title: MACI Primitives description: A short introduction of the main primitives used by MACI sidebar_label: Primitives -sidebar_position: 4 +sidebar_position: 6 --- ## MACI primitives diff --git a/website/versioned_docs/version-v1.x/purpose.md b/website/versioned_docs/version-v1.x/purpose.md index 7e60b70c38..d1d298f739 100644 --- a/website/versioned_docs/version-v1.x/purpose.md +++ b/website/versioned_docs/version-v1.x/purpose.md @@ -13,7 +13,7 @@ Below we attempt to summarize some of the points layed out in that post: ## Security requirements of a voting system -Any voting system requires some crucial security properties: +Any voting system requires a few crucial security properties in order to be trusted by users: - **Correct execution**: the result (tally of votes) must be correct, and the result must be guaranteed by a transparent process (so that everyone is convinced that the result is correct) - **Censorship resistance**: anyone eligible to vote should be able to vote, and it should not be possible to interfere with anyone's attempt to vote or to prevent anyone’s vote from being counted @@ -26,7 +26,7 @@ Looking at various approaches to implement a voting system, we can see how they ### In-person voting systems -In short, it's hard to know for sure how current voting systems operate. Governments and corporations spend lots of resources into ensuring their integrity, but ultimately the processes are not fully auditable so we must trust that these security properties are being enforced. +In short, it's hard to know for sure how current voting systems operate. Governments and corporations spend lots of resources on their systems and processes in an attempt to ensure their integrity, but ultimately neither the systems nor the processes are fully auditable, so we must trust that these security properties are being enforced. | | In-person | | --------------------- | --------- | @@ -37,9 +37,9 @@ In short, it's hard to know for sure how current voting systems operate. Governm ### Blockchain voting systems -Blockchains provide two key properties: correct execution and censorship resistance. In terms of execution, the blockchain accepts inputs (transaction) from users, correctly processes them according to some pre-defined rules, and returns the correct output. No one is able to change the rules. Any user that wants to send a transaction, and is willing to pay a high enough fee, can send the transaction and expect to see it quickly included on-chain. +Blockchains provide two key properties: correct execution and censorship resistance. In terms of execution, the blockchain accepts inputs (transaction) from users, correctly processes them according to some pre-defined rules, and returns the correct output. No one is able to change the rules. Any user that wants to send a transaction and is willing to pay a high enough fee can send the transaction and expect to see it quickly included on-chain. -By default, however, Blockchain voting faces challenges. Ethereum, like most blockchains, is completely transparent - all transaction data is public, so there is no privacy. This makes bribery very easy as a result: someone can easily show a receipt that proves how they voted. The process may even be able to be automated via smart contracts to make collusion entirely trustless. +By default, however, Blockchain voting applications face challenges. Ethereum, like most blockchains, is completely transparent - all transaction data is public, so there is no privacy for voters or their votes. This makes bribery very easy as a result: someone can easily show a transaction receipt that proves how they voted. In some cases, bribery can be completely automated via smart contracts to make collusion entirely trustless. | | In-person | Ethereum | | --------------------- | --------- | -------- | @@ -50,7 +50,7 @@ By default, however, Blockchain voting faces challenges. Ethereum, like most blo ### Blockchain voting systems (with ZKPs) -Enter zero-knowledge proofs (ZKPs), and voting systems like MACI. With ZK, you can have private on-chain voting but maintain public on-chain results that are verifiable by anyone. +Enter zero-knowledge proofs (ZKPs), which when combined with blockchains like Ethereum, can enable private on-chain voting but maintain public on-chain results that are verifiable by anyone (including smart contracts). Vote tallying takes place off-chain but ZKPs are submitted and verified on-chain, which guarantees votes are counted correctly without revealing the individual votes. | | In-person | Ethereum | Ethereum w/ ZK | | --------------------- | --------- | -------- | -------------- | @@ -58,3 +58,5 @@ Enter zero-knowledge proofs (ZKPs), and voting systems like MACI. With ZK, you c | Censorship resistance | πŸ€·β€β™‚οΈ | βœ… | βœ… | | Privacy | πŸ€·β€β™‚οΈ | ❌ | βœ… | | Collusion resistance | πŸ€·β€β™‚οΈ | ❌ | βœ… | + +This, in essence, is why MACI exists. By combining these technologies in novel ways, we believe we can achieve all the core security properties that a voting system must have. diff --git a/website/versioned_docs/version-v1.x/spec.md b/website/versioned_docs/version-v1.x/spec.md index c65fbb6ec2..b41316c37b 100644 --- a/website/versioned_docs/version-v1.x/spec.md +++ b/website/versioned_docs/version-v1.x/spec.md @@ -2,7 +2,7 @@ title: MACI v1.0 Specification description: A detailed specification meant to assist auditors in reviewing MACI version 1.0 sidebar_label: Specification -sidebar_position: 15 +sidebar_position: 17 --- # MACI v1.0 Specification diff --git a/website/versioned_docs/version-v1.x/testing-in-detail.md b/website/versioned_docs/version-v1.x/testing-in-detail.md index ff79c54791..f9c37cd9ec 100644 --- a/website/versioned_docs/version-v1.x/testing-in-detail.md +++ b/website/versioned_docs/version-v1.x/testing-in-detail.md @@ -2,7 +2,7 @@ title: MACI Testing in Detail description: How MACI tests work in detail sidebar_label: Testing in detail -sidebar_position: 10 +sidebar_position: 12 --- # Testing in detail diff --git a/website/versioned_docs/version-v1.x/testing.md b/website/versioned_docs/version-v1.x/testing.md index 9a6b65be90..135bf1c4e3 100644 --- a/website/versioned_docs/version-v1.x/testing.md +++ b/website/versioned_docs/version-v1.x/testing.md @@ -2,7 +2,7 @@ title: Testing MACI description: An introduction on how to test MACI sidebar_label: Testing -sidebar_position: 9 +sidebar_position: 11 --- # Testing introduction diff --git a/website/versioned_docs/version-v1.x/topup.md b/website/versioned_docs/version-v1.x/topup.md index f5e27f1678..7d1f310b84 100644 --- a/website/versioned_docs/version-v1.x/topup.md +++ b/website/versioned_docs/version-v1.x/topup.md @@ -2,7 +2,7 @@ title: MACI Topup description: How the Topup feature works sidebar_label: Topup -sidebar_position: 19 +sidebar_position: 22 --- # Topup diff --git a/website/versioned_docs/version-v1.x/troubleshooting.md b/website/versioned_docs/version-v1.x/troubleshooting.md index d2168c978d..73aa42861a 100644 --- a/website/versioned_docs/version-v1.x/troubleshooting.md +++ b/website/versioned_docs/version-v1.x/troubleshooting.md @@ -2,7 +2,7 @@ title: Troubleshooting description: How to troubleshoot MACI's failures sidebar_label: Troubleshooting -sidebar_position: 17 +sidebar_position: 19 --- # Troubleshooting diff --git a/website/versioned_docs/version-v1.x/trusted-setup.md b/website/versioned_docs/version-v1.x/trusted-setup.md index 65ef047daa..8011dc7403 100644 --- a/website/versioned_docs/version-v1.x/trusted-setup.md +++ b/website/versioned_docs/version-v1.x/trusted-setup.md @@ -2,7 +2,7 @@ title: MACI Trusted Setup description: Introduction to the MACI multi-party trusted setup sidebar_label: Trusted Setup -sidebar_position: 8 +sidebar_position: 10 --- # Trusted setup diff --git a/website/versioned_docs/version-v1.x/versioning.md b/website/versioned_docs/version-v1.x/versioning.md index 5806a09f39..6f5455bc9c 100644 --- a/website/versioned_docs/version-v1.x/versioning.md +++ b/website/versioned_docs/version-v1.x/versioning.md @@ -2,7 +2,7 @@ title: MACI versioning and release process description: How MACI's versioning and release process works sidebar_label: MACI versioning -sidebar_position: 18 +sidebar_position: 20 --- # MACI versioning and release process diff --git a/website/versioned_docs/version-v1.x/workflow.md b/website/versioned_docs/version-v1.x/workflow.md index 6d83e42708..7cf47000b4 100644 --- a/website/versioned_docs/version-v1.x/workflow.md +++ b/website/versioned_docs/version-v1.x/workflow.md @@ -2,7 +2,7 @@ title: MACI Workflow description: Overview of the MACI workflow sidebar_label: Workflow -sidebar_position: 2 +sidebar_position: 3 ---