docs: convert core and prover docs to mdbook project and add CI #3275
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What ❔
docs
core project documentation to mdBook projectprover/docs
prover project documentation to mdBook projectWhy ❔
Fixes #3185
To improve documentation visibility and usability in ZKsync era repository.
Tests
Deployed documentation examples are available in the fork:
Design decisions
It was chosen to use two different workflow files for documentation deployments to keep CI reliable and easy to support regardless of a bit of boilerplate code. Solution with the unified workflow for both projects was implemented but rejected as it is overcomplicated and more difficult to support in the long term.
Checklist
zkstack dev fmt
andzkstack dev lint
.