summaryrefslogtreecommitdiff
path: root/docs/versions/README.md
diff options
context:
space:
mode:
authorOgulcan Celik <ogulcancelik@gmail.com>2026-07-22 14:58:26 +0300
committerOgulcan Celik <ogulcancelik@gmail.com>2026-07-22 14:59:09 +0300
commitc234f221f9be698bc0501c60459e1ae8e67df6c3 (patch)
tree944b4dec10fada8d93456dc5a85e6bfdb36a8b8b /docs/versions/README.md
parentef85fa0c7ebb48bb59fe7593af5a67f3e02ff3d4 (diff)
feat(docs): publish versioned release documentation
Diffstat (limited to 'docs/versions/README.md')
-rw-r--r--docs/versions/README.md13
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.