o1Labs Documentation

This website is built using Docusaurus, a modern static website generator.

Development

Installation

npm i

Build

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

USE_SSH=true npm run deploy

Releasing a New Version

Versioning Stategy

Always create a new version of the docs for a major release. Other than that, try to avoid creating new releases when nothing much has changed. We can make changes to old versions directly, if needed.

How to create a new version

Review versioning docs on Docusuaurus' site.

1. To cut the current version into a historical version, simply run:

./scripts/cut_version.sh

2. Run this script to make sure you have the most up to date o1js artifacts (changelog and autogenerated documentation)

./scripts/update_o1js_artifacts.sh

3. Ensure that the value in .o1js_version reflects the name of the current version of o1js (this value will be used next time you cut a version).

Testing

npm run test