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(zkstack_cli): update docs to mention foundry zksync #3134

Merged
merged 71 commits into from
Nov 13, 2024
Merged
Changes from 1 commit
Commits
Show all changes
71 commits
Select commit Hold shift + click to select a range
714501a
docs: recommend foundry-zksync installation
manuelmauro Oct 21, 2024
bb58441
docs: remove mention to ZKSYNC_HOME
manuelmauro Oct 21, 2024
b57a31c
docs: update mention to foundry-zksync
manuelmauro Oct 21, 2024
4c6026f
docs: update development guide
manuelmauro Oct 21, 2024
002e4bd
docs: add convenience note
manuelmauro Oct 21, 2024
0070e88
style: format code
manuelmauro Oct 21, 2024
5e116a8
docs: add re-installation note
manuelmauro Oct 21, 2024
528a344
style: format code
manuelmauro Oct 21, 2024
7296abb
docs: improve readability
manuelmauro Oct 21, 2024
d488e1e
docs: update launch.md to use zkstack commands
manuelmauro Oct 21, 2024
62f4344
style: format code
manuelmauro Oct 21, 2024
c9f891b
docs: remove dead refs
manuelmauro Oct 22, 2024
1ba533b
docs: remove mention to zk
manuelmauro Oct 22, 2024
18d6bd8
docs: fix initialization chapter
manuelmauro Oct 22, 2024
b37a18c
docs: improve style
manuelmauro Oct 22, 2024
b33633e
Merge branch 'main' into manuel-update-docs-to-mention-foundry-zksync
manuelmauro Oct 23, 2024
4d2eae2
style: format code
manuelmauro Oct 23, 2024
83be284
Merge branch 'main' into manuel-update-docs-to-mention-foundry-zksync
manuelmauro Oct 24, 2024
da2734c
docs: keep postgres section
manuelmauro Oct 24, 2024
f98931a
docs: do not mention ZKSYNC_HOME
manuelmauro Oct 24, 2024
3dfc55e
docs: no need to build contracts manually
manuelmauro Oct 24, 2024
9b44cde
docs: mention location of server's configuration files
manuelmauro Oct 24, 2024
9f14431
docs: add two troubleshoot items
manuelmauro Oct 24, 2024
fa323b2
style: format
manuelmauro Oct 24, 2024
3b9ba47
docs: running prover without a GPU is currently unsupported
manuelmauro Oct 24, 2024
30f3991
docs: document how to run prover on GCP
manuelmauro Oct 24, 2024
26626de
docs: add section on contract verification with foundry
manuelmauro Oct 24, 2024
d1f62a4
docs: add more information on verification options
manuelmauro Oct 24, 2024
fb56e18
docs: update launch docs to use zkstack
manuelmauro Oct 24, 2024
76300be
Update docs/guides/launch.md
manuelmauro Oct 28, 2024
3216bb1
docs: remove outdated section
manuelmauro Oct 28, 2024
7d65381
Update docs/guides/launch.md
manuelmauro Oct 29, 2024
0c2bfc3
Update prover/docs/03_launch.md
manuelmauro Oct 29, 2024
1187124
docs: add note on WVG memory footprint
manuelmauro Oct 29, 2024
1d9d724
docs: add section on prover job monitor
manuelmauro Oct 29, 2024
830a3ad
docs: add section on inserting/querying protocol version in prover DB
manuelmauro Oct 29, 2024
82951c1
style: format code
manuelmauro Oct 29, 2024
f8ec22b
Update docs/guides/development.md
manuelmauro Oct 30, 2024
032da8f
docs: instruct users to install the porject's dependency Foundry ZKsync
manuelmauro Oct 31, 2024
daae0a3
docs: suggest the use of --dev flag for local development
manuelmauro Oct 31, 2024
154e6e0
docs: invite users to supply the --verbose option for long-running co…
manuelmauro Oct 31, 2024
0f309bd
style: format code
manuelmauro Oct 31, 2024
010e7a9
docs: remove Re-initialization section
manuelmauro Oct 31, 2024
027c7d5
style: format code
manuelmauro Oct 31, 2024
a1903e9
Update docs/guides/launch.md
manuelmauro Oct 31, 2024
acc12ee
docs: change recommendation on rust's toolchain version
manuelmauro Oct 31, 2024
cd62bfc
docs: improve "Installing the local ZK Stack CLI" section
manuelmauro Oct 31, 2024
11fee43
docs: refer to setup-dev.md in development.md
manuelmauro Oct 31, 2024
af79a06
docs: improve spelling
manuelmauro Oct 31, 2024
38c9ea8
Merge branch 'main' into manuel-update-docs-to-mention-foundry-zksync
manuelmauro Nov 5, 2024
5b6cd89
docs: recommend client-only PostgreSQL installation
manuelmauro Nov 5, 2024
e9381f9
style: format
manuelmauro Nov 5, 2024
27e8a30
docs: update TL;DR
manuelmauro Nov 5, 2024
09063cc
docs: improve formatting/style
manuelmauro Nov 5, 2024
1956a2e
docs: add section on manually editing config files
manuelmauro Nov 6, 2024
d0f6415
Update docs/guides/advanced/01_initialization.md
manuelmauro Nov 6, 2024
8dc0d03
Update docs/guides/advanced/01_initialization.md
manuelmauro Nov 6, 2024
01f7960
Update docs/guides/advanced/01_initialization.md
manuelmauro Nov 6, 2024
fe4dc52
Update docs/guides/development.md
manuelmauro Nov 6, 2024
1585f8c
Update docs/guides/development.md
manuelmauro Nov 6, 2024
f47ecc3
Update docs/guides/launch.md
manuelmauro Nov 6, 2024
f1041fe
style: format code
manuelmauro Nov 6, 2024
a931c1b
docs: do not suggest a command to install Foundry Zksync
manuelmauro Nov 12, 2024
c888bb4
style: format docs
manuelmauro Nov 12, 2024
6101949
Update docs/guides/advanced/01_initialization.md
manuelmauro Nov 12, 2024
d808f3d
docs: fix tips H level
manuelmauro Nov 12, 2024
fc8d958
docs: expand section on ecosystem configuration
manuelmauro Nov 12, 2024
1ce117b
style: format docs
manuelmauro Nov 12, 2024
4bde05c
docs: give more guidance on running tests
manuelmauro Nov 12, 2024
d170f4c
docs: add load test section
manuelmauro Nov 12, 2024
adbdf50
docs: remove zk_inception and zk_supervisor wording
manuelmauro Nov 12, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update docs/guides/development.md
Co-authored-by: Artur Puzio <contact@puzio.waw.pl>
  • Loading branch information
manuelmauro and cytadela8 authored Oct 30, 2024
commit f8ec22b0bd76d6566b5371e43117737e9d3cd663
2 changes: 1 addition & 1 deletion docs/guides/development.md
Original file line number Diff line number Diff line change
@@ -35,7 +35,7 @@ This command installs `zkstack` from the current source directory.

## Configure Ecosystem

The root directory includes configuration files for an ecosystem with a single chain, `era`. To initialize the
The project root directory includes configuration files for an ecosystem with a single chain, `era`. To initialize the
ecosystem, first start the required containers:

```bash
Loading