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 NEEDED] zk_toolbox CLI commands are not documented #228

Open
dutterbutter opened this issue Sep 24, 2024 · 4 comments
Open

[DOCS NEEDED] zk_toolbox CLI commands are not documented #228

dutterbutter opened this issue Sep 24, 2024 · 4 comments

Comments

@dutterbutter
Copy link
Contributor

  • We have this awesome CLI tool for spawning ZK Chains and its well documented in the README but not present on our official docs. We should document it here as well.
@entuziaz
Copy link

@dutterbutter

Talking of the zk_toolbox: https://github.com/matter-labs/zksync-era/tree/57b99d4fc906ae7ab5532ea23a069b34a2ee7c02/zk_toolbox

I'd like to work on it. Would it be better added as a single page or multiple pages in the docs considering we have the following content?

Table of Contents

1. Introduction

2. zx_toolbox: ZK Inception

a. Installation
b. Prerequisites
c. Foundry Integration
d. Ecosystem Management
e. ZK Chain Management
f. Running the ZK Server
g. Prover Management
h. Contract Verifier
i. External Node Management
j. Portal and Explorer
k. Updating the Node

3. zx_toolbox: ZK Supervisor

a. Database Management
b. Cleaning Artifacts
c. Running Tests
d. Creating Snapshots
e. Building Contracts
f. Formatting Code
g. Linting Code

@entuziaz
Copy link

entuziaz commented Sep 27, 2024

I considered this again and thought to make the docs a multi-page section in the main navigation, with the following folder structure. I'll be submitting a PR to that effect soon.

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

Cc: @dutterbutter @itsacoyote

@popzxc
Copy link
Member

popzxc commented Oct 2, 2024

Right now zk_toolbox is under active development, and soon it'll be renamed, so I believe that adding it to the docs now is a bit premature. For instance, right now we plan to rework CLI structure and rename it.
We will be working with @Deniallugo to make sure that once the tool is production-ready, we will cover it in docs.

@entuziaz
Copy link

entuziaz commented Oct 2, 2024

Alright. That's understandable.
Thanks for the information. Looking forward to the release.

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 a pull request may close this issue.

3 participants