Skip to content

Commit

Permalink
docs(zk_toolbox): Add markdown help (#2562)
Browse files Browse the repository at this point in the history
## What ❔

Autogenerated markdown help, it will allow to make the integration a bit
more straight forward

## Why ❔

<!-- Why are these changes done? What goal do they contribute to? What
are the principles behind them? -->
<!-- Example: PR templates ensure PR reviewers, observers, and future
iterators are in context about the evolution of repos. -->

## Checklist

<!-- Check your PR fulfills the following items. -->
<!-- For draft PRs check the boxes as you complete them. -->

- [ ] 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 `zk fmt` and `zk lint`.

---------

Signed-off-by: Danil <[email protected]>
  • Loading branch information
Deniallugo authored Aug 1, 2024
1 parent f5aaefe commit 23f9d7a
Show file tree
Hide file tree
Showing 10 changed files with 866 additions and 1 deletion.
11 changes: 11 additions & 0 deletions zk_toolbox/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions zk_toolbox/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -54,3 +54,4 @@ tokio = { version = "1.37", features = ["full"] }
toml = "0.8.12"
url = { version = "2.5.0", features = ["serde"] }
xshell = "0.2.6"
clap-markdown = "0.1.4"
1 change: 1 addition & 0 deletions zk_toolbox/crates/zk_inception/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,4 @@ thiserror.workspace = true
zksync_config.workspace = true
slugify-rs.workspace = true
zksync_basic_types.workspace = true
clap-markdown.workspace = true
Loading

0 comments on commit 23f9d7a

Please sign in to comment.