Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation of gatekeepers #1382

Closed
samajammin opened this issue Apr 16, 2024 · 1 comment · Fixed by #1443
Closed

Add documentation of gatekeepers #1382

samajammin opened this issue Apr 16, 2024 · 1 comment · Fixed by #1443
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@samajammin
Copy link
Member

Motivation

I find myself often sharing a link to our gatekeeper contracts:
https://github.com/privacy-scaling-explorations/maci/tree/dev/contracts/contracts/gatekeepers

But there's no README on this directory or page in the MACI documentation that explains how gatekeepers work

Details

Create a new documentation page that explains gatekeepers, how they work, how they can be configured, and how someone might build their own custom gatekeeper contract to use MACI in a new way. More broadly it might be worth having this page explain how identity/authentication/access control happens in MACI, how MACI doesn't aim to solve this problem directly but relies on other solutions (e.g. EAS, Hats Protocol, Gitcoin Passport, whatever solution) to manage the identity & how the MACI gatekeeper contract then uses that identity system or authentication process to register users as eligible to vote.

@samajammin samajammin added documentation Improvements or additions to documentation good first issue Good for newcomers labels Apr 16, 2024
@ctrlc03 ctrlc03 added this to MACI Apr 16, 2024
@ctrlc03 ctrlc03 moved this to Todo in MACI Apr 16, 2024
@iusssmanovv
Copy link

nice

@samajammin samajammin mentioned this issue May 8, 2024
3 tasks
@ctrlc03 ctrlc03 moved this from Todo to In Progress in MACI May 9, 2024
ctrlc03 added a commit that referenced this issue May 22, 2024
* docs: add gatekeeper contract page

* docs: add link to gatekeeper page from contracts page

* docs: update gatekeeper summary [Fixes #1382]

* docs: add link to abstract SignUpGatekeeper

* docs(gatekeepers): refactor gatekeepers docs entry to add more details

---------

Co-authored-by: ctrlc03 <[email protected]>
@github-project-automation github-project-automation bot moved this from In Progress to Done in MACI May 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants