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.

Sign up for GitHub

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

Jump to bottom

docs: add docs for zk_toolbox #231

Closed
wants to merge 2 commits into from
Closed

docs: add docs for zk_toolbox #231

wants to merge 2 commits into from

Conversation

entuziaz
Copy link

Description

This PR adds the documentation for zk_toolbox to the ZKSync docs website. It includes 3 pages:

  1. Getting Started:
    • Overview information
    • Who should use zk_toolbox
    • ZK Toolbox vs ZKSync CLI
    • Installation Guide
  2. ZK Inception
    • Prerequisites
    • Foundry Integration
    • CLI Commands
  3. ZK Supervisor
    • CLI Commands

It has the following folder structure:

 . . .
 ┣ 📂25.zk-toolbox
 ┃ ┣ 📜00.index.md
 ┃ ┣ 📜10.zk-inspection.md
 ┃ ┣ 📜20.zk-supervisor.md
 ┃ ┗ 📜_dir.yaml
 . . .

Linked Issues

This PR resolves #228

@entuziaz entuziaz requested a review from a team as a code owner September 27, 2024 20:56
@entuziaz entuziaz mentioned this pull request Sep 29, 2024
Open
@shahar4
Copy link

shahar4 commented Sep 30, 2024

Thank you so much for this PR. We'll send it to the relevant team for review ASAP.

@popzxc
Copy link
Member

popzxc commented Oct 2, 2024

Hey! Thank you for your PR.
zk_toolbox is currently under active development, and adding documentation for it to the site is in our plans; however, this will be tackled a bit later.
We won't be merging this PR for now, since these docs will very likely become outdated very fast.

I've also updated the original issue with more details.

@popzxc popzxc closed this Oct 2, 2024
@entuziaz
Copy link
Author

entuziaz commented Oct 2, 2024

Alright. Thanks for letting me know, @popzxc.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[DOCS NEEDED] zk_toolbox CLI commands are not documented
3 participants
@entuziaz @shahar4 @popzxc