Skip to main content

Asymmetric versioning example

This is a minimal demo of independent per-product version switchers in one Docusaurus site, for the Logos Storage docs re-plan:

  • Node docs — version independently on logos-storage-nim tags (currently 0.4.1, with a 0.4.0 snapshot and an unreleased Next).
  • Module docs — version independently on logos-storage-module tags (currently 2.0.1, with a 2.0.0 snapshot and an unreleased Next).
  • Learn — narrative pages with no version dimension.

Try it: open a Node page and a Module page and use the two dropdowns in the navbar — each switches only its own section.

Cutting a release touches only that product's snapshots:

npx docusaurus docs:version:node 0.4.2
npx docusaurus docs:version:module 2.1.0

To deploy this site to https://emizzle.github.io/logos-storage-docs/:

SITE_URL=https://emizzle.github.io BASE_URL=/logos-storage-docs/ USE_SSH=true npx docusaurus deploy

Will build a static production build of the site and push it to the gh-pages branch, which is set up for GH pages at the above URL.

When/if we need a custom domain, eg docs.logos.storage, deploy with:

SITE_URL=https://docs.logos.storage BASE_URL=/ npx docusaurus deploy

(and add a static/CNAME)