search

privacy-scaling-explorations / maci

Minimal Anti-Collusion Infrastructure (MACI)
https://maci.pse.dev/
Other
507 stars 128 forks source link

Create documentation page(s) from A Technical Introduction to MACI 1.0 #878

Closed samajammin closed 5 months ago

samajammin commented 8 months ago

@kcharbo3 created this amazing post last year: A Technical Introduction to MACI 1.0

The post covers two main topics:

  1. System Overview a. Roles b. Vote Overriding and Public Key Switching c. zk-SNARKs

  2. Workflow a. Sign Up b. Publish Message c. Process Messages d. Tally Votes

I think we should incorporate this content within our documentation so that we can keep it up to date as MACI evolves. Kyle gave me the go-ahead to do this - thanks Kyle!

I suggest we create 2 new docs pages:

  1. System overview - explain the "roles" of the system and how they interact with MACI, as well as key pieces of the system (like vote overriding & key switching)
  2. Workflow - explain the lifecycle of MACI: deploying, running a poll, finalizing results, both the "happy path" for a simple case, as well as a more complex example (e.g. if a user switches keys & overrides their votes)

Open to feedback here - input appreciated!

samajammin commented 8 months ago

Self-assigning, happy to take this on.

ctrlc03 commented 5 months ago

@samajammin is this completed by #1223 ?

samajammin commented 5 months ago

Yes, fixed in https://github.com/privacy-scaling-explorations/maci/pull/1223