search

matter-labs / zksync-docs

Developer documentation site for zkSync community.
https://docs.zksync.io/
Apache License 2.0
5 stars 27 forks source link

docs: add docs for zk_toolbox #231

Closed J-rayX closed 2 days ago

J-rayX commented 1 week ago

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 https://github.com/matter-labs/zksync-docs/issues/228

shahar4 commented 4 days ago

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

popzxc commented 2 days ago

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.

J-rayX commented 2 days ago

Alright. Thanks for letting me know, @popzxc.