Here is the setup required to locally run the docs if you want to modify it.

We are using github actions and github pages to automatically update and publish docs after each merge to main.

Run Locally

  1. Make sure you have Ruby installed.
  2. Install the bundle: bundle or bundle install
  3. Run the server: bundle exec jekyll serve
  4. Check it out in: http://127.0.0.1:4000/

Table of contents