Skip to main content

Documentation Website

You can contribute to this Docusaurus page by forking our docs repo.

You will need to install Node.js >= 18.0. You can obtain the recommended LTS at https://nodejs.org/en/download.

In addition, you will need npm and yarn (can be installed from npm) package managers. Consider using pnpm over npm.

With the repo checked out, you can cd into the docs directory, run yarn install to download all the dependencies, and start a local docs webserver (that will reflect your MDX changes in real-time) via yarn start.

We recommend you utilize our javadocs while updating any Docusaurus page to ensure accuracy.