Skip to content

docs: Add README.md for verify_stark#1774

Merged
jonathanpwang merged 5 commits into
mainfrom
docs/verify-stark
Jun 25, 2025
Merged

docs: Add README.md for verify_stark#1774
jonathanpwang merged 5 commits into
mainfrom
docs/verify-stark

Conversation

@nyunyunyunyu

Copy link
Copy Markdown
Contributor

close INT-4031

Comment thread guest-libs/verify_stark/README.md Outdated
Comment thread guest-libs/verify_stark/README.md Outdated

@jonathanpwang jonathanpwang left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@HrikB please provide suggestions on doc updates for clarity

@HrikB HrikB left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I would suggest that the docs are separated along the lines of host / guest for clarity (how the guest will interact with library and how the host should prepare inputs for the guest). And the guest section can include a subsection on how compilation will require preparation of the asm file.

Comment thread guest-libs/verify_stark/README.md Outdated
nyunyunyunyu and others added 4 commits June 24, 2025 16:49
Co-authored-by: Jonathan Wang <31040440+jonathanpwang@users.noreply.github.com>
Co-authored-by: HrikB <23041116+HrikB@users.noreply.github.com>
Adds documentation for the Verify STARK guest library to the book.

@jonathanpwang jonathanpwang left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@jonathanpwang jonathanpwang merged commit 9afb2c7 into main Jun 25, 2025
10 checks passed
@jonathanpwang jonathanpwang deleted the docs/verify-stark branch June 25, 2025 01:15
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