-
Notifications
You must be signed in to change notification settings - Fork 50
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 builtins documentation for cairo vm #379
Docs: Add builtins documentation for cairo vm #379
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To be honest, I liked the beginning but after that it all started feeling more and more as something generated by an IA and no honest effort put into it.
Some general feedback:
- Is ok to write just what you understood of builtins.
- If you wanted to write more, is ok for you to ask us questions, we will gladly answer or point towards some documentation.
- Is ok to make mistakes
On the other hand is not Ok to fill the PR with content just for the sake of filling it with content. Usually the content doesn't adds anything meaningful, at instances, is slightly correct but it will cause more confusion than anything. Just by trying to run some Cairo Code (or reading the docs) you would realize that there are things written here that don't make sense (which begs the question, how much effort was put into this PR).
Some specific feedback:
- The introduction can stay as is
What is builtins in Cairo
andBuiltins and Cairo memory
should be explained as what they are without any analogies.General types of builtins in Cairo VM
: The concept is good, but it has builtins I don't know about. Also,sepcific builtins in Cairo Vm
could be merged with this section.- Finally,
How builtins perform ...
should explain the trade-off that brings builtins to the table which has nothing to do with what was written in that section.
Hi! @rodrigo-pino |
@rodrigo-pino I already made the commit with the requested changes |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Much better @jimenezz22 ! Thank you. Just some comments
Hi! @rodrigo-pino |
@jimenezz22 do you have any updates on this? |
@rodrigo-pino I was waiting for you to answer the questions I had about the comments. In the next few hours you will have the issue ready |
@rodrigo-pino new commit ready |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cool, just some nitpicks. Will approve once resolved
@rodrigo-pino Changes made! Waiting for approval. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
left minor comments. Looks good overall, a few improvments should be done but this can be done later in another PR
…zz22/cairo-vm-go into BuiltinsDocumentation#326
Co-authored-by: Rodrigo <[email protected]>
This PR is for the issue Builtins Documentation #326. Adding a complete documentation to understand how builtins works on cairo virtual machine and how bulitins perform complex operations at the cost of extra constraints when proving.