This repo contains static legacy documentation and release assets.
Documentation articles are found in directories like _docs-*.
Made with Jekyll.
Prerequisites:
- Node.js 22.16 or later
- pnpm 10.28
- Ruby 3.4
- RubyGems Bundler
Run:
# If you use RVM, select the Ruby version declared by .ruby-version:
rvm use .
bundle install
pnpm install# watch & serve while developing
pnpm dev
# build into _site directory
pnpm buildThe development site is served at Jekyll's default port http://localhost:4000.
The generated _site directory is deployed as static assets on Cloudflare Workers.
Workers Builds should use these commands:
# build command
pnpm cloudflare:build
# production deploy command
pnpm cloudflare:deploy
# non-production branch deploy command
pnpm cloudflare:previewSet PNPM_VERSION to 10.28.0 in the Workers Builds environment. Ruby and
Node.js are selected from .ruby-version and .node-version.
See a problem with the docs? Create a ticket in the main dev repo's issue tracker. All docs-related bugs have the docs label.
To make edits to the documentation please submit a Pull Request against the main branch of this repo.
Ensure linting passes before submitting PRs:
pnpm lint