Skip to main content
stableENLast updated Mar 21, 2026

Docs Versioning Strategy

Guidelines for rolling versions and changelogging major documentation updates.

handbookversioning

Philosophy

We version docs when the gameplay experience or public APIs change in incompatible ways. Routine copy edits stay on the live version.

Version Types

VersionTriggerStorage
currentDefault branchdocs/ root
vX.YMajor gameplay updateversions/vX.Y/ (mirrors structure)
legacyUnsupported contentArchived branch or zipped export

Release Flow

  1. Prepare changes under docs/.
  2. Once the update ships, copy the folder into versions/vX.Y/ and freeze.
  3. Update docs/en/reference/changelog.md with highlights and links.
  4. Ensure search indexing excludes archived versions unless explicitly requested (configure Meilisearch filter).

Changelog

Use semantic headings:

## [v2.0.0] - 2025-11-21
### Added
- ...

The docs/en/reference/changelog.md file keeps the public record synchronized with in-game releases.


Found a typo or missing info?

Edit this page on GitHub and help other trainers.

Edit on GitHub