-
Notifications
You must be signed in to change notification settings - Fork 38
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
Move documentation to Github Pages #557
Conversation
Doc deployed at https://0xpolygonzero.github.io/zk_evm/. Once good to merge, I'll update the CI to be triggered only on pushes onto |
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.
Big fan of this!
I do wonder how much we can move to rustdoc
.
In my experience, out-of-tree documentation is always at higher risk of getting stale.
It would be great to see these resources be tied to the code, with rust-managed hyperlinks etc.
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.
Now the real fun begins.
@0xaatif I agree, there is a BIG todo list around the overall documentation, with several points that would need internal discussions first before addressing. We could probably open a discussion on that topic and start going through how we want our doc to look like, its covered area, etc. |
Turn the documentation into mdBook style and deploy to Github Pages
I should have taken care of all hyperlinks tweaks, but it's possible some slipped through.
More generally, given that now everything is under the monorepo, I think it'd be nice to extend the doc not just to the backend arithmetization but to the whole zk_evm stack, how the leader / workers are orchestrated, the whole data flow, etc...