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 #3275

Merged

Conversation

antonbaliasnikov
Copy link
Contributor

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 force-pushed the 3185-deploy-core-and-prover-documentation-to-gh-pages-rebased branch from 0481179 to c39df42 Compare November 14, 2024 11:44
@antonbaliasnikov antonbaliasnikov requested a review from a team as a code owner November 14, 2024 11:44
@antonbaliasnikov antonbaliasnikov force-pushed the 3185-deploy-core-and-prover-documentation-to-gh-pages-rebased branch from c39df42 to 347c3a2 Compare November 14, 2024 11:44
@antonbaliasnikov antonbaliasnikov force-pushed the 3185-deploy-core-and-prover-documentation-to-gh-pages-rebased branch from 347c3a2 to 5e84f08 Compare November 14, 2024 12:41
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.

❤️

@popzxc popzxc added this pull request to the merge queue Nov 15, 2024
Merged via the queue into main with commit 64e77ce Nov 15, 2024
32 checks passed
@popzxc popzxc deleted the 3185-deploy-core-and-prover-documentation-to-gh-pages-rebased branch November 15, 2024 05:01
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
3 participants