o1js Reference

As noted in the docs2/CONTRIBUTING the o1js reference content docs are auto-generated from the o1js code. Updates to the and is outside the scope of content updates in the /docs2 repo.

Today, it's a manual step to publish updates to o1js Reference contents.

To publish updates to the o1js Reference docs:

1. Go to https://github.com/o1-labs/docs2/actions.

2. In the sidebar, select o1js-API-Reference.

3. Select Run workflow.

4. For Use workflow from Branch, select main.

   This action starts an automated job that generates new reference docs and creates a PR on the docs2 repo. The job is in pending status for about 18 minutes.

5. Submit the PR for approval by a code owner, and then merge the PR to publish the o1js Reference docs.

On a related note, the o1js release schedule is every other Tuesday (cadence continues from Tuesday, March 5, and so on). Be sure to kick off the o1js-API-Reference action for each release.