Commit bead2fa
committed
docs: fix code snippets verified against the actual z6m_prover binary
Verified every CLI claim by running `docker run somnergy/z6m_prover ...`
against `latest`. The published image is the source of truth for what
users actually see — `master` of erigontech/zilkworm has refactored some
flags/descriptions but the image hasn't been rebuilt yet, so docs should
match the image until a new image ships.
## Real bugs (fixed)
- **docs/basics/getting-started.md (CUDA example)** — `--n 1` is not a real
flag in any version. Replace with `--block-number 1` (which the binary
actually accepts).
- **src/pages/index.tsx (landing hero)** — `z6m_prover verify proof.json`
would clap-error: the `verify` subcommand has no positional argument,
only `--proof-path` (default `proof.bin`) and `--vk-path` (default
`vk.bin`). Rewrite to `z6m_prover verify --proof-path proof.json
--vk-path vk.bin`.
- **docs/testing/riscv-testing-eests-on-rv32im-via-qemu.md** — `make
rv32im_eest_blockchain_tests` does not exist in `qemu_runner/Makefile`.
The intended target is `make eest-rv32` (or `make eest-blockchain-tests`
which defaults to `ARCH=rv32`).
## Re-verified, left as-is
The prove/execute option tables (including `--is-test` and the
"JSON file..." / "Whether the input file is..." descriptions) match the
binary verbatim — these were temporarily "corrected" against master
source in an earlier draft of this PR and have been reverted to match
what users see when they actually run `--help`.1 parent 1b2ad23 commit bead2fa
4 files changed
Lines changed: 5 additions & 5 deletions
File tree
- docs
- basics
- testing
- src/pages
- static
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
98 | 98 | | |
99 | 99 | | |
100 | 100 | | |
101 | | - | |
| 101 | + | |
102 | 102 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
54 | 54 | | |
55 | 55 | | |
56 | 56 | | |
57 | | - | |
| 57 | + | |
58 | 58 | | |
59 | 59 | | |
60 | 60 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
104 | 104 | | |
105 | 105 | | |
106 | 106 | | |
107 | | - | |
| 107 | + | |
108 | 108 | | |
109 | 109 | | |
110 | 110 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
177 | 177 | | |
178 | 178 | | |
179 | 179 | | |
180 | | - | |
| 180 | + | |
181 | 181 | | |
182 | 182 | | |
183 | 183 | | |
| |||
388 | 388 | | |
389 | 389 | | |
390 | 390 | | |
391 | | - | |
| 391 | + | |
392 | 392 | | |
393 | 393 | | |
394 | 394 | | |
| |||
0 commit comments