-
Notifications
You must be signed in to change notification settings - Fork 236
Add ZK page to docs #2216
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
base: main
Are you sure you want to change the base?
Add ZK page to docs #2216
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Adds a new documentation page covering zero-knowledge proof primitives (BN254 + Poseidon) for Stellar and exposes it via the built docs routes list.
Changes:
- Added a new
ZK Proofs on Stellardocumentation page under Build → Apps. - Updated
routes.txtto include the new docs route.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| routes.txt | Adds the generated route entry for the new ZK docs page. |
| docs/build/apps/zk.mdx | Introduces new ZK-focused documentation content and links to related resources. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Preview is available here: |
|
Preview is available here: |
|
Preview is available here: |
ElliotFriend
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks like a great start! Left some thoughts, but there's very little that I would consider deal-breakers.
Thanks!
docs/build/apps/zk.mdx
Outdated
| - `g1_add` - performs point addition in G1 (point on curve) | ||
| - `g1_mul` - performs scalar multiplication in G1 (point on curve) | ||
| - `pairing_check` - performs pairing operation on a vector of G1 points and a vector of G2 points |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These descriptions seem a little "inside baseball" for someone who might be less well-versed in ZK arithmetic. Would probably be useful to make them a little simpler
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @ElliotFriend! Accepted suggestions and tried to make the descriptions a little better. LMK what you think.
Co-authored-by: Elliot Voris <elliot@stellar.org>
Co-authored-by: Elliot Voris <elliot@stellar.org>
Co-authored-by: Elliot Voris <elliot@stellar.org>
Co-authored-by: Elliot Voris <elliot@stellar.org>
|
Preview is available here: |
4 similar comments
|
Preview is available here: |
|
Preview is available here: |
|
Preview is available here: |
|
Preview is available here: |
https://developers-pr2216.previews.kube001.services.stellar-ops.com/docs/build/apps/zk