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

Document PSE fork features #226

Merged

Conversation

han0110
Copy link

@han0110 han0110 commented Nov 8, 2023

Resolves #223

Also pick the fix from #195

Copy link
Member

@CPerezz CPerezz left a comment

Choose a reason for hiding this comment

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

Thanks for documenting all this Han!

I have a couple of extra suggestions (which we can address in other PRs if you prefer):

  • Include examples in the halo2_proofs examples folder about every single API experimental feature. Such that one can easily get some guidelines on how to use them. Then link the examples to the corresponding book sections.
  • Add some info on the README.md about this book section.

book/src/user/experimental-features.md Outdated Show resolved Hide resolved
book/src/user/experimental-features.md Outdated Show resolved Hide resolved
book/src/user/experimental-features.md Outdated Show resolved Hide resolved
book/src/user/experimental-features.md Outdated Show resolved Hide resolved
book/src/user/experimental-features.md Outdated Show resolved Hide resolved
book/src/user/experimental-features.md Outdated Show resolved Hide resolved
book/src/user/experimental-features.md Outdated Show resolved Hide resolved
@han0110 han0110 requested a review from CPerezz November 10, 2023 06:10
Copy link
Member

@CPerezz CPerezz left a comment

Choose a reason for hiding this comment

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

LGTM!

Still think would be valuable to add minimal code pieces with feature examples and how the API looks.
But we can defer that for a future PR!

Thanks for the amendments!

@CPerezz CPerezz merged commit 324c886 into privacy-scaling-explorations:main Nov 10, 2023
12 checks passed
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.

Add a new page in book to list all features PSE fork adds
2 participants