Skip to content

Version Policy

Tag To Docs Version Mapping

  • Git tag format: vX.Y.Z
  • Published docs stream: X.Y

Examples:

  • v1.0.0 -> docs version 1.0
  • v1.3.4 -> docs version 1.3

Alias Rules

  • latest: newest released docs stream
  • stable: mirrors latest
  • next: prerelease documentation from mainline

Publish Commands

./scripts/publish-docs-version.sh v1.0.0 --push

This wrapper runs:

mike deploy --branch docs-site --update-aliases 1.0 latest stable
mike set-default --branch docs-site latest

Guardrails

  • Do not publish from docs-site branch
  • Do not publish if tag format is invalid
  • Always validate docs with mkdocs build --strict before deploy