cairo-book / cairo-book

The Cairo Programming Language Book, a comprehensive documentation of the Cairo 1 programming language.
https://book.cairo-lang.org/
MIT License
228 stars 218 forks source link

Help in adding CairoVM documentation #888

Open gerceboss opened 2 months ago

gerceboss commented 2 months ago

I am new to Cairo and Starknet , I have not studied CairoVM in depth, was looking forward to doing that, so if it's possible I would like to help in writing the cairoVM documentation in the book, in that way I will study it as well and can help.

enitrat commented 2 months ago

Great idea :) it's probably good to start by reading https://github.com/kkrt-labs/cairo-vm-ts and https://github.com/lambdaclass/cairo-vm

gerceboss commented 2 months ago

@enitrat, Thanks a lot, is there any place where I can directly talk to people involved in this? That will be better if I keep in touch about how things must be structured and how they need to be written. That might also help in setting up a timeline to me.

enitrat commented 2 months ago

You can find reference links in the Repo I linked, otherwise you can read the Cairo whitepaper

gerceboss commented 2 months ago

@enitrat, Great, np. Can you tell whom to contact while writing content for the book? It should be discussed as this might not be a small task.

enitrat commented 2 months ago

you can contact me directly. @zmalatrax wrote the cairo vm in typescript, @TAdev0 wrote it in Go, while I can help the overall writing direction and quality

gerceboss commented 1 month ago

@enitrat , I have completed reading the research paper of cairoVM/ cairo. Can I start writing? Or I should understand the implementations first? And if yes, how should sections and everything needs to be structured , can you guide on that ?

enitrat commented 1 month ago

@gerceboss you can start writing any chapter on which you have a solid understanding if you want. Note that this work is the one of a technical writer, but it's not simply a documentation: there must be a "common thread" that guides the reader through the chapters.

We can discuss the content before writing, if you'd like.

@zmalatrax has written an introduction with a structure and tone that is perfect for this work