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

docs: add links to the source code of the relevant smart contracts #1253

Closed
samajammin opened this issue Feb 27, 2024 · 7 comments · Fixed by #1646
Closed

docs: add links to the source code of the relevant smart contracts #1253

samajammin opened this issue Feb 27, 2024 · 7 comments · Fixed by #1646
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@samajammin
Copy link
Member

Motivation

As a developer reading the documentation to learn about MACI, I'd like to be able to easily view the source code

Details

For each smart contract documentation page, include a link to the corresponding source code

e.g. for this contract:
https://maci.pse.dev/docs/solidity-docs/gatekeepers/EASGatekeeper

There should be a link to "view the code" which goes to:
https://github.com/privacy-scaling-explorations/maci/blob/dev/contracts/contracts/gatekeepers/EASGatekeeper.sol

@samajammin samajammin added documentation Improvements or additions to documentation good first issue Good for newcomers labels Feb 27, 2024
@Ayoseun
Copy link

Ayoseun commented Mar 6, 2024

Can you assign this to me

@ctrlc03
Copy link
Collaborator

ctrlc03 commented Mar 16, 2024

Can you assign this to me

@Ayoseun Thanks for the interest in working on this! assigned you! ps I just updated (#1300) the smart contracts doc page with more up to date info, so might be worth waiting for this to be merged and start from there

@Ayoseun
Copy link

Ayoseun commented Mar 16, 2024 via email

@samajammin
Copy link
Member Author

Thanks for taking this on @Ayoseun! Let us know how we can help support 😄

@ctrlc03 ctrlc03 added this to MACI Apr 16, 2024
@ctrlc03 ctrlc03 moved this to In Progress in MACI Apr 16, 2024
@aguzmant103
Copy link
Member

Hi @Ayoseun ! Do you have any update on this task progress?

@ctrlc03
Copy link
Collaborator

ctrlc03 commented Jul 8, 2024

@Ayoseun are there any updates on this? we might have to un-assign you soon (~1 week) if you do not reply, so that someone else can pick it up instead 🙂

@ctrlc03
Copy link
Collaborator

ctrlc03 commented Jul 15, 2024

@Ayoseun Due to inactivity on this thread we will be un-assigning you for now, but we welcome you to re-engage with the project as you find a suitable issue to work on. Thanks for your initial interest to contribute to MACI and looking forward to any future contribution

@ctrlc03 ctrlc03 assigned ctrlc03 and unassigned Ayoseun Jul 15, 2024
@github-project-automation github-project-automation bot moved this from In Progress to Done in MACI Jul 15, 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.

4 participants