aboutsummaryrefslogtreecommitdiff
path: root/docs/versions/README.md
blob: 023d23f76fe64005080c7d7697189df28e6d2bc1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
# Versioned documentation

This directory contains immutable documentation snapshots for stable Herdr releases.

Do not edit snapshot files manually. They must match the release tag recorded in `manifest.json`. Validate them with:

```bash
node website/scripts/docs-versions.mjs check
```

Release CI creates a new snapshot from the tagged `docs/next` tree after the GitHub Release succeeds. `website/scripts/prepare-docs.mjs` renders these snapshots at `/docs/<version>/` while keeping `/docs/` on the latest stable documentation and `/docs/preview/` on unreleased work.

The historical backfill starts at v0.5.11, the first release that included the Astro/Starlight documentation site.