-
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 introduction documentation for cairo vm - Issue #328 #381
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.
Hey @coxmars
I left a first bunch of comments on your PR but it looks good overall!!
Did you use AI for the part about builtins? We should avoid things like:
" These include managing resource usage effectively to prevent performance degradation or vulnerabilities, ensuring robust security measures to mitigate risks such as integer overflow, reentrancy attacks, and access control issues, and maintaining compatibility with existing standards and protocols within the blockchain ecosystem. "
Thank you for the feedback, I will apply the changes as soon as possible and I will modify that sentence to avoid that kind of explanation |
Hi @TAdev0 can you review these changes please, I considered all your comments for this improvement but if something is needed to improve I will do it, thanks. |
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 another bunch of comments! @coxmars
hi @coxmars any update on this? |
I'm finishing applying the changes, I'll let you know as soon as I have it. |
Hey @coxmars if you need any help please let us know |
Hi Rodrigo, I would like you to give me some context/guidance on the resources section, what do you mean by that? I did not find related information or maybe I did not understand the specific approach to address the explanation. Thank you. |
@TAdev0 improvements applied if you need other changes just let me know, thanks |
This PR is for the issue Intro Documentation #328. Added intro documentation to understand in a general way all the sections as a small summary of what we'll see in the specific parts.