docs: convert core and prover docs to mdbook project and add CI #3202
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
antonbaliasnikov
requested review from
yorik,
alexandrst88,
artmakh,
hatemosphere,
onyxet,
otani88 and
iluwaa
antonbaliasnikov
force-pushed
the
3185-deploy-core-and-prover-documentation-to-gh-pages
branch
from
5b2a490
to
abae4db
Compare
antonbaliasnikov
requested review from
popzxc
and removed request for
yorik,
alexandrst88,
artmakh,
hatemosphere,
onyxet,
otani88 and
iluwaa
antonbaliasnikov
force-pushed
the
3185-deploy-core-and-prover-documentation-to-gh-pages
branch
from
abae4db
to
9785095
Compare
antonbaliasnikov
force-pushed
the
3185-deploy-core-and-prover-documentation-to-gh-pages
branch
from
9785095
to
7151d41
Compare
popzxc
reviewed
Oct 31, 2024
antonbaliasnikov
force-pushed
the
3185-deploy-core-and-prover-documentation-to-gh-pages
branch
from
7151d41
to
e34b077
Compare
antonbaliasnikov
force-pushed
the
3185-deploy-core-and-prover-documentation-to-gh-pages
branch
2 times, most recently
from
94bd048
to
20a089b
Compare
|
@popzxc , I fixed all issues. Please take another look when possible. |
|
@antonbaliasnikov the CI is green, but the diff is now over 200k lines for some reason 😅 |
antonbaliasnikov
force-pushed
the
3185-deploy-core-and-prover-documentation-to-gh-pages
branch
from
20a089b
to
f1dc9f7
Compare
|
New rebased PR is here #3275 |
antonbaliasnikov
deleted the
3185-deploy-core-and-prover-documentation-to-gh-pages
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 ❔
docscore project documentation to mdBook projectprover/docsprover 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 fmtandzkstack dev lint.