From cf7fdf9d528358ebceb50fce0281f1b4d1bd4fa5 Mon Sep 17 00:00:00 2001 From: Sam Richards Date: Sat, 13 Jan 2024 17:23:40 -0800 Subject: [PATCH 1/4] chore: rename file to testing-in-detail --- .../version-v1.x/{testing-in-details.md => testing-in-detail.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename website/versioned_docs/version-v1.x/{testing-in-details.md => testing-in-detail.md} (100%) diff --git a/website/versioned_docs/version-v1.x/testing-in-details.md b/website/versioned_docs/version-v1.x/testing-in-detail.md similarity index 100% rename from website/versioned_docs/version-v1.x/testing-in-details.md rename to website/versioned_docs/version-v1.x/testing-in-detail.md From d352781fa6dbc117dbc036720fa536fc7247a93c Mon Sep 17 00:00:00 2001 From: Sam Richards Date: Sat, 13 Jan 2024 17:28:15 -0800 Subject: [PATCH 2/4] fix: update to singular "in detail" --- .../versioned_docs/version-v1.x/testing-in-detail.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) 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 3bad51a409..dc841c20c3 100644 --- a/website/versioned_docs/version-v1.x/testing-in-detail.md +++ b/website/versioned_docs/version-v1.x/testing-in-detail.md @@ -1,13 +1,13 @@ --- -title: MACI Testing in Details -description: How MACI tests work in details -sidebar_label: How Our Test Suites Work +title: MACI Testing in Detail +description: How MACI tests work in detail +sidebar_label: Testing in detail sidebar_position: 10 --- -# Testing +# Testing in detail -This doc extends on the [Testing](https://maci.pse.dev/docs/testing.md) doc and explains how MACI tests work in details. This information should be used by MACI's maintainers as well as contributors. +This doc expands on our [introduction to testing](https://maci.pse.dev/docs/testing.md) doc and explains how MACI tests work in greater detail. This information should be used by MACI's maintainers as well as contributors. ## Automated Tests From c906a94b5e201e6102795c0881058f74699cc629 Mon Sep 17 00:00:00 2001 From: Sam Richards Date: Sat, 13 Jan 2024 17:31:45 -0800 Subject: [PATCH 3/4] fix: internal doc links --- website/blog/2023-01-18-maci-v1.1.1.md | 4 ++-- website/versioned_docs/version-v1.x/circuits.md | 4 ++-- website/versioned_docs/version-v1.x/installation.md | 2 +- website/versioned_docs/version-v1.x/testing-in-detail.md | 4 ++-- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/website/blog/2023-01-18-maci-v1.1.1.md b/website/blog/2023-01-18-maci-v1.1.1.md index acd4315c49..f4c4035e21 100644 --- a/website/blog/2023-01-18-maci-v1.1.1.md +++ b/website/blog/2023-01-18-maci-v1.1.1.md @@ -92,9 +92,9 @@ For further reading on coordinator services, please refer to this [doc](https:// MACI can be used as a standalone application to carry out on-chain polls, or be implemented into new projects that can then benefit from its properties. -For use as a standalone application, a `cli` package is provided which allows coordinators and voters to use MACI. Please refer to this [doc](https://maci.pse.dev/docs/cli.html) for details on how to use it. +For use as a standalone application, a `cli` package is provided which allows coordinators and voters to use MACI. Please refer to this [doc](/docs/cli) for details on how to use it. -To implement MACI into a project, the [documentation](https://maci.pse.dev/docs/introduction) can be used a reference, as well as reviewing how [clr.fund](https://github.com/clrfund) and [qf](https://github.com/privacy-scaling-explorations/qf) use MACI in their code. +To implement MACI into a project, the [documentation](/docs/introduction) can be used a reference, as well as reviewing how [clr.fund](https://github.com/clrfund) and [qf](https://github.com/privacy-scaling-explorations/qf) use MACI in their code. ## MACI 0.x diff --git a/website/versioned_docs/version-v1.x/circuits.md b/website/versioned_docs/version-v1.x/circuits.md index 21e795a8d4..0b5c2f2ed0 100644 --- a/website/versioned_docs/version-v1.x/circuits.md +++ b/website/versioned_docs/version-v1.x/circuits.md @@ -431,7 +431,7 @@ circom --r1cs --sym --wasm --output ./build circom/test/processMessages_test.cir circom --r1cs --sym --wasm --output ./build circom/test/tallyVotes_test.circom ``` -Please note that the circuit is configured with testing purpose parameters, which means it can only handle a limited amount of messages (up to 25 messages). For more information on the parameters and how to configure them, refer to [this page](https://maci.pse.dev/docs/circuits.html#compile-circuits). +Please note that the circuit is configured with testing purpose parameters, which means it can only handle a limited amount of messages (up to 25 messages). For more information on the parameters and how to configure them, refer to [this page](/docs/circuits/#compile-circuits). ### Generating zKeys @@ -486,4 +486,4 @@ To run individual tests, you can use the following commands (for all other circu - `pnpm run test-processMessages` to run the tests for the `processMessages` circuit. - `pnpm run test-tallyVotes` to run the tests for the `tallyVotes` circuit. -More details on testing are provided in the [testing section](https://maci.pse.dev/docs/testing) of the documentation. +More details on testing are provided in the [testing section](/docs/testing) of the documentation. diff --git a/website/versioned_docs/version-v1.x/installation.md b/website/versioned_docs/version-v1.x/installation.md index ebc6601346..6faba64cd6 100644 --- a/website/versioned_docs/version-v1.x/installation.md +++ b/website/versioned_docs/version-v1.x/installation.md @@ -86,7 +86,7 @@ MACI has two main zk-SNARK circuits (plus an optional Subsidy circuit). Each cir Unless you wish to generate a fresh set of `.zkey` files, you should obtain them from someone who has performed a multi-party trusted setup for said -circuits. For more details on which artifacts have undergone a trusted setup, please refer to the [Trusted Setup](https://maci.pse.dev/docs/trusted-setup) page. +circuits. For more details on which artifacts have undergone a trusted setup, please refer to the [Trusted Setup](/docs/trusted-setup) page. Note the locations of the `.zkey` files as the CLI requires them as command-line flags. 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 dc841c20c3..b7869006f2 100644 --- a/website/versioned_docs/version-v1.x/testing-in-detail.md +++ b/website/versioned_docs/version-v1.x/testing-in-detail.md @@ -7,7 +7,7 @@ sidebar_position: 10 # Testing in detail -This doc expands on our [introduction to testing](https://maci.pse.dev/docs/testing.md) doc and explains how MACI tests work in greater detail. This information should be used by MACI's maintainers as well as contributors. +This doc expands on our [introduction to testing](/docs/testing) doc and explains how MACI tests work in greater detail. This information should be used by MACI's maintainers as well as contributors. ## Automated Tests @@ -171,7 +171,7 @@ Within the circuits folder, there are a number of tests that are used to verify These tests often use mock data from the `core` package. For instance, when testing the `processMessages` circuit, we are required to generate the parameters from the `core` packing, using the `Poll:processMessages` function. The same applies to vote tallying, where we need the `Poll:tally` function to be run first with mock users and vote messages. -All of the tests run using test parameters, usually `10, 2, 1, 2`, aside from the tests inside: [`ceremonyParam`](https://github.com/privacy-scaling-explorations/maci/blob/dev/circuits/ts/__tests__/CeremonyParams.test.ts) which use the parameters of the latest MACI ceremony. More details on the trusted setup can be found [here](https://maci.pse.dev/docs/trusted-setup). +All of the tests run using test parameters, usually `10, 2, 1, 2`, aside from the tests inside: [`ceremonyParam`](https://github.com/privacy-scaling-explorations/maci/blob/dev/circuits/ts/__tests__/CeremonyParams.test.ts) which use the parameters of the latest MACI ceremony. More details on the trusted setup can be found [here](/docs/trusted-setup). ### Core From 688225c0a5d783fa8b585578e4ca0662e4ad1bd1 Mon Sep 17 00:00:00 2001 From: Sam Richards Date: Sat, 13 Jan 2024 17:34:57 -0800 Subject: [PATCH 4/4] chore: update testing header --- website/versioned_docs/version-v1.x/testing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/website/versioned_docs/version-v1.x/testing.md b/website/versioned_docs/version-v1.x/testing.md index cf13062245..8e1243c588 100644 --- a/website/versioned_docs/version-v1.x/testing.md +++ b/website/versioned_docs/version-v1.x/testing.md @@ -1,11 +1,11 @@ --- title: Testing MACI -description: How to test MACI +description: An introduction on how to test MACI sidebar_label: Testing sidebar_position: 9 --- -# Testing +# Testing introduction ## Unit tests