cairo-vm-go icon indicating copy to clipboard operation
cairo-vm-go copied to clipboard

Docs: Add introduction documentation for cairo vm - Issue #328

Open coxmars opened this issue 1 year ago • 6 comments

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.

coxmars avatar Apr 30 '24 07:04 coxmars

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

coxmars avatar May 02 '24 02:05 coxmars

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.

coxmars avatar May 03 '24 02:05 coxmars

hi @coxmars any update on this?

TAdev0 avatar May 07 '24 20:05 TAdev0

hi @coxmars any update on this?

I'm finishing applying the changes, I'll let you know as soon as I have it.

coxmars avatar May 08 '24 12:05 coxmars

Hey @coxmars if you need any help please let us know

rodrigo-pino avatar May 10 '24 09:05 rodrigo-pino

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.

coxmars avatar May 14 '24 06:05 coxmars

@TAdev0 improvements applied if you need other changes just let me know, thanks

coxmars avatar May 25 '24 01:05 coxmars