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

docs: convert core and prover docs to mdbook project and add CI #3202

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

antonbaliasnikov
Copy link

What ❔

Why ❔

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

  • PR title corresponds to the body of PR (we generate changelog entries from PRs).
  • Tests for the changes have been added / updated.
  • Documentation comments have been added / updated.
  • Code has been formatted via zkstack dev fmt and zkstack dev lint.

@antonbaliasnikov antonbaliasnikov requested a review from a team as a code owner October 30, 2024 16:23
@antonbaliasnikov antonbaliasnikov force-pushed the 3185-deploy-core-and-prover-documentation-to-gh-pages branch from 5b2a490 to abae4db Compare October 30, 2024 16:24
@antonbaliasnikov antonbaliasnikov force-pushed the 3185-deploy-core-and-prover-documentation-to-gh-pages branch from abae4db to 9785095 Compare October 30, 2024 16:30
@antonbaliasnikov antonbaliasnikov force-pushed the 3185-deploy-core-and-prover-documentation-to-gh-pages branch from 9785095 to 7151d41 Compare October 30, 2024 17:00
Copy link
Member

@popzxc popzxc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey! Changes LGTM, but looks like linter is not happy about changes to markdown files. You probably need to run zkstack dev fmt / zkstack dev lint and/or allow certain warnings if they make no sense.

@antonbaliasnikov antonbaliasnikov force-pushed the 3185-deploy-core-and-prover-documentation-to-gh-pages branch from 7151d41 to e34b077 Compare October 31, 2024 11:34
@antonbaliasnikov antonbaliasnikov force-pushed the 3185-deploy-core-and-prover-documentation-to-gh-pages branch from e34b077 to 94bd048 Compare October 31, 2024 11:52
@antonbaliasnikov antonbaliasnikov force-pushed the 3185-deploy-core-and-prover-documentation-to-gh-pages branch from 94bd048 to 20a089b Compare October 31, 2024 12:05
@antonbaliasnikov
Copy link
Author

@popzxc , I fixed all issues. Please take another look when possible.

@popzxc
Copy link
Member

popzxc commented Nov 1, 2024

@antonbaliasnikov the CI is green, but the diff is now over 200k lines for some reason 😅

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Deploy core and prover documentation to GH Pages
2 participants