diff options
Diffstat (limited to 'docs/versions/README.md')
| -rw-r--r-- | docs/versions/README.md | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/versions/README.md b/docs/versions/README.md new file mode 100644 index 00000000..023d23f7 --- /dev/null +++ b/docs/versions/README.md @@ -0,0 +1,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. |