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.

Sign up for GitHub

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

Jump to bottom

docs: create smart contract architecture diagrams #1202

Closed
samajammin opened this issue Feb 17, 2024 · 2 comments · Fixed by #1305
Closed

docs: create smart contract architecture diagrams #1202

samajammin opened this issue Feb 17, 2024 · 2 comments · Fixed by #1305
Assignees
@kittybest @wiasliaw
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@samajammin
Copy link
Member

Motivation

As a user or developer looking to learn more about MACI, I'd love to see visual resources to understand the high-level architecture of the MACI system

Details

Add charts to https://maci.pse.dev/docs/contracts/

Similar to
image

But include MACI & Poll contracts like
image
@samajammin samajammin added documentation Improvements or additions to documentation good first issue Good for newcomers labels Feb 28, 2024
@samajammin samajammin changed the title Create smart contract architecture diagrams docs: create smart contract architecture diagrams Feb 28, 2024
@wiasliaw
Copy link
Contributor

wiasliaw commented Mar 7, 2024

draft pic here. If it is acceptable then I can make a PR. I ignored some detail like contract deployment and updating commitment to MessageProcessor, Tally and Subsidy.

image

@ctrlc03
Copy link
Collaborator

ctrlc03 commented Mar 16, 2024 •
edited
Loading

draft pic here. If it is acceptable then I can make a PR. I ignored some detail like contract deployment and updating commitment to MessageProcessor, Tally and Subsidy.

image

@wiasliaw This looks great! feel free to work on this and thanks very much.
ps. it's Poll not Pool

@wiasliaw wiasliaw mentioned this issue Mar 17, 2024
Merged
3 tasks
@ctrlc03 ctrlc03 added this to MACI Apr 10, 2024
@ctrlc03 ctrlc03 moved this to In Progress in MACI Apr 10, 2024
@github-project-automation github-project-automation bot moved this from In Progress to Done in MACI Apr 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kittybest kittybest

@wiasliaw wiasliaw

Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
MACI
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs(diagram): add contract architecture diagram wiasliaw/maci
4 participants
@samajammin @kittybest @wiasliaw @ctrlc03