Skip to content

Commit ee117a8

Browse files
authored
fix: zkstack readme update broken links and wording (#3375)
## What ❔ Hi @Deniallugo @popzxc πŸ‘‹ Was playing with zkstack cli today. This PR is just fixing a couple of broken links and updating a bit of wording in `zkstack_cli/README.md`. PS: sidenote, "EVM emulator" is not explained in this readme, and "Enable EVM emulator?" in interactive mode will be confusing to people (they likely wont realize that it is emulating EVM equivalence but not required for most chains + will be more expensive) ## Why ❔ Possibly a bit OCD, ie "Zk" being wrongly cased in one instance stayed in my mind and bothered me hahahah πŸ˜‰ <!-- 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. --> - [x] PR title corresponds to the body of PR (we generate changelog entries from PRs). - [x] Tests for the changes have been added / updated. - [x] Documentation comments have been added / updated. - [x] Code has been formatted via `zkstack dev fmt` and `zkstack dev lint`.
1 parent 9821445 commit ee117a8

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

β€Žzkstack_cli/README.mdβ€Ž

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# ZK Stack CLI
22

3-
Toolkit for creating and managing ZK Stack chains. `ZK Stack CLI` facilitates the creation and management of ZK Stacks.
4-
Commands are interactive but can also accept arguments via the command line.
3+
Toolkit for creating and managing ZK Stack chains. `ZK Stack CLI` facilitates the creation and management of ZK Stack
4+
ecosystems. Commands are interactive but can also accept arguments via the command line.
55

66
### Dependencies
77

8-
Follow [these instructions](https://github.com/matter-labs/zksync-era/blob/main/docs/guides/setup-dev.md) to set up
8+
Follow [these instructions](https://github.com/matter-labs/zksync-era/blob/main/docs/src/guides/setup-dev.md) to set up
99
dependencies on your machine. Ignore the Environment section for now.
1010

1111
### Installation
@@ -48,7 +48,7 @@ Foundry is used for deploying smart contracts. Pass flags for Foundry integratio
4848
### Ecosystem
4949

5050
ZK Stack allows you to create a new ecosystem or connect to an existing one. An ecosystem includes components like the
51-
BridgeHub, shared bridges, and state transition managers.
51+
BridgeHub, shared bridges, and state transition managers. Multiple ZK chains can be registered to an ecosystem.
5252
[Learn more](https://docs.zksync.io/zk-stack/components/shared-bridges).
5353

5454
#### Global Config
@@ -140,15 +140,15 @@ zkstack containers --observability
140140

141141
#### Create
142142

143-
The first ZK chain is generated upon ecosystem creation. Create additional chains and switch between them:
143+
The first ZK chain is generated upon ecosystem creation. You can also create additional chains and switch between them:
144144

145145
```bash
146146
zkstack chain create
147147
```
148148

149149
#### Init
150150

151-
Deploy contracts and initialize Zk Chain:
151+
Deploy contracts and initialize ZK chain:
152152

153153
```bash
154154
zkstack chain init
@@ -184,7 +184,7 @@ Ensure you have installed:
184184
- [cmake](https://apt.kitware.com/)
185185
- [nvcc (CUDA toolkit)](https://developer.nvidia.com/cuda-downloads)
186186

187-
Refer to the [prover docs](https://github.com/matter-labs/zksync-era/blob/main/prover/docs/02_setup.md) for more
187+
Refer to the [prover docs](https://github.com/matter-labs/zksync-era/blob/main/prover/docs/src/02_setup.md) for more
188188
information.
189189

190190
#### Running the Prover
@@ -313,7 +313,7 @@ needed.
313313

314314
## Dev
315315

316-
The subcommand `zkstack dev` offers tools for developing ZKsync.
316+
The subcommand `zkstack dev` offers tools for developing.
317317

318318
### Database
319319

0 commit comments

Comments
Β (0)