Skip to content

docs: refresh READMEs#585

Merged
MauroToscano merged 9 commits into
mainfrom
update_readme
May 18, 2026
Merged

docs: refresh READMEs#585
MauroToscano merged 9 commits into
mainfrom
update_readme

Conversation

@ColoCarletti
Copy link
Copy Markdown
Collaborator

No description provided.

@claude
Copy link
Copy Markdown

claude Bot commented May 13, 2026

Review

This PR is documentation-only (all 6 changed files are README/markdown updates). No code changes.

Documentation quality looks good:

  • CLI README improvements: clearer command syntax using ./target/release/cli instead of cargo run, added flag reference tables, added count-elements command docs
  • New executor/README.md and prover/README.md with usage examples and API tables
  • spec/README.md cleaned up and clarified
  • New syscalls/README.md documenting the guest SDK API
  • Root README updated with CLI quickstart and corrected file paths

One minor note: The syscalls README example has a redundant double-module path — syscalls::syscalls::get_private_input() instead of the more ergonomic syscalls::get_private_input(). Worth checking whether the public API re-exports the inner module's functions at the crate root.

No security, bug, or performance concerns.

@github-actions
Copy link
Copy Markdown

Codex Code Review

Finding: Low Security

prover/README.md shows prove + verify as the complete verifier-side pattern, but it never checks proof.public_output against an expected public claim. In a zkVM integration, verification only proves the guest executed consistently with the committed output; the caller still needs to validate that output is the statement they intended to accept. The new syscalls/README.md example also commits the entire private input back as public output, which is a risky default example for a “private input” API.

Action: update the examples to compare proof.public_output to an expected value, and avoid using “echo private input” as the primary SDK example unless it explicitly warns that committed bytes are public.

@ColoCarletti ColoCarletti changed the title add readme docs: refresh READMEs May 13, 2026
@ColoCarletti ColoCarletti marked this pull request as ready for review May 13, 2026 20:20
Comment thread syscalls/README.md
@claude
Copy link
Copy Markdown

claude Bot commented May 13, 2026

Documentation-only PR. All API names, file paths, and feature flags were verified against the source — they're accurate.

One minor issue filed inline: the example in syscalls/README.md aliases the crate as syscalls and then calls syscalls::syscalls::get_private_input(). The double-module path is confusing; importing the inner module directly (use lambda_vm_syscalls::syscalls;) reads much cleaner.

@github-actions
Copy link
Copy Markdown

Codex Code Review

No findings.

The PR only changes documentation/README files. I did not find concrete security, correctness, significant performance, or simplicity issues in the changed diff.

Comment thread README.md Outdated
Comment thread prover/README.md Outdated
Comment thread spec/README.md Outdated
Comment thread executor/README.md Outdated
Comment thread README.md Outdated
Comment thread README.md Outdated
Comment thread README.md
Comment thread README.md
Comment thread README.md
Comment thread README.md Outdated
Comment thread README.md
Copy link
Copy Markdown
Collaborator

@gabrielbosio gabrielbosio left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

executor/README.md and syscalls/README.md should be accessible through root README

- Add clang + lld (with RISC-V target) to README dependencies section
  so users don't fail at `make compile-programs-asm`
- Add `default_value = "2"` to --blowup in both prove and verify
  subcommands so `--help` shows the default
- Fix verify --time help text ("Print verification time" not "timing breakdown")
- Match [default: 2] style in bin/cli/README.md tables
@MauroToscano MauroToscano added this pull request to the merge queue May 18, 2026
Merged via the queue into main with commit d9bcafa May 18, 2026
11 checks passed
@MauroToscano MauroToscano deleted the update_readme branch May 18, 2026 14:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants