HF doc audit for o1js docs: Recursion, Smart Contracts #841
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
barriebyron
added
docs
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Ignored Deployment
|
barriebyron
commented
Feb 13, 2024
barriebyron
commented
Feb 13, 2024
barriebyron
commented
Feb 13, 2024
barriebyron
commented
Feb 13, 2024
barriebyron
commented
Feb 13, 2024
docs/zkapps/o1js/smart-contracts.md
Outdated
| @@ -166,7 +131,7 @@ As a zkApp developer, if you add this method to your smart contract, you are say | |||
|
|
|||
| ## Reading state | |||
|
|
|||
| Often, we also want to _read_ state – check out this example: | |||
| This example _reads_ state: | |||
There was a problem hiding this comment.
do we want to provide a reason to read state? (the often statement can be enhanced)
There was a problem hiding this comment.
Maybe leave it as is until we start getting questions about this?
barriebyron
commented
Feb 13, 2024
barriebyron
commented
Feb 15, 2024
docs/zkapps/o1js/recursion.mdx
Outdated
| ::: | ||
|
|
||
| In o1js, you can use `ZkProgram()` to define the steps of a recursive program. Just like `SmartContract()` methods, `ZkProgram()` methods have any number of methods and execute off-chain. | ||
| In o1js, you can use `ZkProgram()` to define the steps of a recursive program. Like `SmartContract()` methods, `ZkProgram()` methods have any number of methods and execute off-chain. |
There was a problem hiding this comment.
@mitschabaude wdyt about just omitting mention of a fixed limit of methods?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR continues work for the Audit non-tutorial zkApps docs before HF epic:
HF audit zkApp docs: Recursion #480
handy preview link https://docs2-git-hf4-doc-audit-minadocs.vercel.app/zkapps/o1js/recursion
HF audit zkApp docs: Smart Contracts #481
handy preview link https://docs2-git-hf4-doc-audit-minadocs.vercel.app/zkapps/o1js/smart-contracts
The technical review requires verifying the code snippets in each doc and the code in the examples linked from these pages. Thanks @jackryanservia for teaching me how to run the code. Related PR #845