Skip to content
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

Merged
merged 8 commits into from
Aug 28, 2024
Merged

Move documentation to Github Pages #557

merged 8 commits into from
Aug 28, 2024

Conversation

Nashtare
Copy link
Collaborator

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...

@Nashtare Nashtare self-assigned this Aug 28, 2024
@Nashtare Nashtare requested a review from muursh as a code owner August 28, 2024 13:42
@Nashtare Nashtare added this to the x Misc. milestone Aug 28, 2024
@github-actions github-actions bot added the specs label Aug 28, 2024
@Nashtare
Copy link
Collaborator Author

Nashtare commented Aug 28, 2024

Doc deployed at https://0xpolygonzero.github.io/zk_evm/.
I've updated README accordingly and (created +) updated https://0xpolygonzero.github.io/.

Once good to merge, I'll update the CI to be triggered only on pushes onto main / develop

Copy link
Contributor

@0xaatif 0xaatif left a 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.

Copy link
Contributor

@muursh muursh left a 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.

@Nashtare
Copy link
Collaborator Author

@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.

@Nashtare Nashtare enabled auto-merge (squash) August 28, 2024 15:53
@Nashtare Nashtare merged commit 4ff1194 into develop Aug 28, 2024
15 checks passed
@Nashtare Nashtare deleted the doc/gp branch August 28, 2024 16:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants