This website is built using Docusaurus, a modern static website generator.
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
During local development, only the current docs (in the docs/ folder) are served without versioning. This provides a faster development experience.
This command generates versioned docs from git refs, then builds static content into the build directory.
To build without generating versions (uses only the current docs/ folder):
The documentation supports multiple versions to maintain docs for different releases. Versioned docs are generated at build time from git release branches to avoid maintaining duplicate content in the repository.
docs/) — Working documentation from trunk, served at /docs/trunkrelease/<major>.<minor> branches
/docs/next/docs/docs/v1.10, etc.The version generation script (scripts/generate-versions.sh) auto-detects release branches and uses git archive to extract docs from each without checking out the full repository.
When releasing a new version (e.g., v2.1):
Create a release branch for the new version:
That's it! The build script auto-detects release branches matching the release/<major>.<minor> pattern. The next build will automatically include the new version.
Test the build locally:
/docs — Latest stable release (default)/docs/next — Next release (unreleased, highest version branch)/docs/trunk — Working docs from trunk/docs/v1.10 — Previous release versionsTo update docs for a released version, push changes directly to the corresponding release branch:
The next build will pick up the updated docs from the release branch.