docs: fix code snippets to match actual zilkworm source#2
Open
bloxster wants to merge 1 commit into
Open
Conversation
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`.
bloxster
force-pushed
the
docs/code-snippet-source-truth
branch
from
28c0eb8 to
bead2fa
Compare
There was a problem hiding this comment.
Pull request overview
This PR updates documentation and the landing page CLI examples so the commands shown match the behavior and flags exposed by the currently published somnergy/z6m_prover:latest Docker image (treated as the user-facing source of truth).
Changes:
- Fix
proveexample to use--block-numberinstead of a non-existent--nflag. - Fix
verifyexample to use--proof-path/--vk-pathflags instead of an invalid positional argument. - Update the RISC-V EEST QEMU guide to use the correct
maketarget and regeneratestatic/llms-full.txtto reflect doc changes.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/basics/getting-started.md | Fixes CUDA proving snippet flag usage to match the Docker image CLI. |
| src/pages/index.tsx | Updates the landing page “prove/verify” example command to match actual verify CLI syntax. |
| docs/testing/riscv-testing-eests-on-rv32im-via-qemu.md | Updates the documented make target for running EESTs on RV32IM via QEMU. |
| static/llms-full.txt | Regenerates the LLM snapshot to reflect the updated docs content. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
105
to
+107
| const exampleCommand = `// Create block proofs in one command | ||
| z6m_prover prove --block-number 23456789 --proof-path proof.json | ||
| z6m_prover verify proof.json`; | ||
| z6m_prover verify --proof-path proof.json --vk-path vk.bin`; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Verified every CLI claim by actually running
docker run somnergy/z6m_prover ...againstlatest. The published Docker image is the source of truth for what users see —masteroferigontech/zilkwormhas refactored some flag descriptions but the image hasn't been rebuilt yet, so docs should match the image until a new one ships.Real bugs (fixed)
docs/basics/getting-started.md(CUDA example)z6m_prover prove --n 1 --file-name test.json—--nis not a real flag in any version of the binaryz6m_prover prove --block-number 1 --file-name test.jsonsrc/pages/index.tsx(landing hero)z6m_prover verify proof.json— would clap-error:verifyhas no positional argument, only--proof-path(defaultproof.bin) and--vk-path(defaultvk.bin)z6m_prover verify --proof-path proof.json --vk-path vk.bindocs/testing/riscv-testing-eests-on-rv32im-via-qemu.mdmake rv32im_eest_blockchain_tests— target does not exist inqemu_runner/Makefilemake eest-rv32static/llms-full.txtscripts/generate-llms.pyEarlier draft reverted
An earlier version of this PR "corrected" the
prove/executeoption tables againstmastersource — dropping--is-test, rewriting--block-numberdescription, rewriting--file-namedescription. That was wrong: the current Docker image still has--is-testand prints the older descriptions verbatim. Reverted those changes so the tables match what users actually see.If/when a new Docker image ships from current
master, those table entries will need a follow-up update.Could not verify
Test plan
docker run somnergy/z6m_prover --helpmatches the docs verbatimdocker run somnergy/z6m_prover {prove,execute,fetch,verify} --helpeach matches the docs verbatimnpm run typecheckcleannpm run buildclean