Tutorial standards

Tutorial standards

Tutorials are learning-oriented for learning how to achieve a defined goal.

Tutorials are a series of guided steps for a zkApp developer to complete a specific project so that a beginner can achieve a goal using the product.

Audience

Write for the zkApp developer audience using the second person pronoun "you":

This Hello World tutorial helps you get started with SnarkyJS, zkApps, and programming with zero-knowledge proofs. In this step-by-step tutorial, you learn to code a zkApp from start to finish.

Use second person: "you" rather than "we."

Present tense

Use present tense rather than future tense.

Active voice

Use active voice: make clear who's performing the action.

Code blocks

Code blocks must be valid TypeScript code. See Tutorial Runner.

See Markdown Syntax.

Examples

Each tutorial requires a working example in https://github.com/o1-labs/docs2/tree/main/examples/zkapps.