Skip to content

Add more detailed documentation to Semaphore V4 contracts and libraries #483

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
Closed
10 tasks done
cedoor opened this issue Dec 18, 2023 · 0 comments · Fixed by #661
Closed
10 tasks done

Add more detailed documentation to Semaphore V4 contracts and libraries #483

cedoor opened this issue Dec 18, 2023 · 0 comments · Fixed by #661
Assignees
@cedoor @0xjei @vplasencia
Labels
documentation 📖 Improvements or additions to documentation
Milestone
Semaphore V4 Release

Comments

@cedoor
Copy link
Member

cedoor commented Dec 18, 2023 •
edited
Loading

Tasks:
@cedoor cedoor converted this from a draft issue Dec 18, 2023
@cedoor cedoor added this to the Semaphore V4 milestone Dec 18, 2023
@cedoor cedoor added the documentation 📖 Improvements or additions to documentation label Dec 18, 2023
@cedoor cedoor mentioned this issue Dec 18, 2023
Merged
2 tasks
@cedoor cedoor moved this from ♻️ Grooming to 🗒 Tasks in Semaphore Board Jan 24, 2024
@cedoor cedoor moved this from 🗒 Tasks to 🏗 In Progress in Semaphore Board Jan 25, 2024
@cedoor cedoor moved this from 🏗 In Progress to 🗒 Tasks in Semaphore Board Jan 25, 2024
@cedoor cedoor moved this from 🗒 Tasks to 🏗 In Progress in Semaphore Board Feb 6, 2024
cedoor added a commit that referenced this issue Feb 27, 2024
@cedoor
docs(circuits): add documentation to circuits
de12d47 
This commit add more documentation to the Semaphore circuits, with the aim of providing an overview
of the code used and to refer to other resources for futher information.

re #483
@cedoor cedoor mentioned this issue Feb 27, 2024
Merged
9 tasks
@cedoor cedoor linked a pull request Feb 27, 2024 that will close this issue
More documentation on Circom code #661
Merged
9 tasks
cedoor added a commit that referenced this issue Feb 28, 2024
@cedoor
docs(identity): add more documentation to code
b4c2887 
The commit adds more documentation to the Identity class and update the TypeDoc link. It also
removes the class method to verify signatures as the static method can be used instead.

re #483
@cedoor cedoor mentioned this issue Feb 28, 2024
Merged
9 tasks
cedoor added a commit that referenced this issue Feb 28, 2024
@cedoor
docs(identity): add more documentation to code
f3ee07c 
The commit adds more documentation to the proof package functions and updates the TypeDoc link.

re #483
@cedoor cedoor mentioned this issue Feb 28, 2024
Merged
9 tasks
cedoor added a commit that referenced this issue Feb 28, 2024
@cedoor
docs(circuits): add more documentation to secret signal
23476c3 
re #483
cedoor added a commit that referenced this issue Feb 28, 2024
@cedoor
docs(identity): add links to zk-kit types
0034f5f 
re #483
cedoor added a commit that referenced this issue Feb 28, 2024
@cedoor
docs(circuits): add link to identity package
cf65ec4 
re #483
cedoor added a commit that referenced this issue Feb 28, 2024
@cedoor
docs(circuits): revert order of hash pre-images on comments
b5acd41 
re #483
cedoor added a commit that referenced this issue Feb 28, 2024
@cedoor
docs(circuits): minor improvements on doc comments
c3389b6 
re #483
cedoor added a commit that referenced this issue Feb 28, 2024
@cedoor
docs(group): add more documentation to code
cf2355f 
The commit adds more documentation to the group package functions and updates the TypeDoc link.

re #483
@cedoor cedoor mentioned this issue Feb 28, 2024
Merged
9 tasks
@vplasencia vplasencia mentioned this issue Feb 28, 2024
Merged
9 tasks
This was referenced May 6, 2024
Merged
Merged
Merged
@0xjei 0xjei moved this from 🏗 In Progress to 👀 In review in Semaphore Board May 7, 2024
@cedoor cedoor closed this as completed May 7, 2024
@github-project-automation github-project-automation bot moved this from 👀 In review to ✔️ Done in Semaphore Board May 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@cedoor cedoor

@0xjei 0xjei

@vplasencia vplasencia

Labels
documentation 📖 Improvements or additions to documentation
Projects
Semaphore Board
Status: ✔️ Done
Milestone
Semaphore V4 Release
Development

Successfully merging a pull request may close this issue.

More documentation on Circom code semaphore-protocol/semaphore
4 participants
@cedoor @0xjei @vplasencia and others