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. (Optional) Create a historical version to be preserved a. First, ensure you have the intended version of o1js installed - package.json should be set to the correct historical version - run npm i - Set .o1js-version to the installed version, this will be used to tell docusaurus what to call the historical version b. To check that the historical version is ready to be preserved, run these checks - npm run spellcheck - npm run link-check - npm run test - Fix any errors before cutting the version c. Run ./scripts/cut_version.sh to actually create the versioned docs
2. Update the current version of the docs to the latest o1js a. Run ./scripts/update_o1js_artifacts.sh - This will pull the latest from o1js, generate the docs, and move them into this repo's docs/ folder - It will also do some automated metadata tagging of the autogenerated files b. Run npm run build to find any issues from the latest autogenerated docs - Common issues are: Symbols like > and {} are not escaped properly in doc comments and make the markdown file unparseable c. Run the following checks to see if any changes have occured since the last version - npm run spellcheck - npm run link-check - npm run test

Testing

npm run test