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

ZkProgram doc updates for new non-experimental #711

Closed
barriebyron opened this issue Oct 31, 2023 · 2 comments
Closed

ZkProgram doc updates for new non-experimental #711

barriebyron opened this issue Oct 31, 2023 · 2 comments
Labels
docs Improvements or additions to documentation zkApps Focused zkApps content

Comments

@barriebyron
Copy link
Contributor

We missed corresponding doc updates for o1-labs/o1js#1200
@garwalsh can you provide product guidance on how we present the ZkProgram API.
It will be helpful to have a doc we can link to. The only doc that mentions it is https://docs.minaprotocol.com/zkapps/o1js/recursion with an experimental flag.

Questions:
how to use which flavor?
benefits and differences?

@barriebyron barriebyron added docs Improvements or additions to documentation zkApps Focused zkApps content labels Oct 31, 2023
@garwalsh
Copy link
Contributor

@mitschabaude
In o1-labs/o1js#1200 it states:

  • name is required in the new non-experimental API, but still optional in the old Experimental.ZkProgram

When you say "the old Experimental.ZkProgram" does that refer to a developer who has not updated to today's release?
I ask because I don't think we need to keep docs that align with deprecated versions of o1js.

If that's the case, then outstanding docs work should be:

@mitschabaude
Copy link
Contributor

Yes agree with that assessment @garwalsh

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation zkApps Focused zkApps content
Projects
None yet
Development

No branches or pull requests

3 participants