diff options
| author | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-08-04 03:58:48 +0300 |
|---|---|---|
| committer | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-08-04 03:59:22 +0300 |
| commit | cffc6c4b50178d404fbb939346dab7a33e5ed8d4 (patch) | |
| tree | 7ca1cdfd9b669ca1bbd23d0c800c4a1047913e99 /docs/versions/README.md | |
| parent | b12da23918ff94099e7fcedd7db79f3d2fa8fa6f (diff) | |
fix(docs): allow corrections to published versions
refs #916
Diffstat (limited to 'docs/versions/README.md')
| -rw-r--r-- | docs/versions/README.md | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/docs/versions/README.md b/docs/versions/README.md index dbfd01f6..42ca1c69 100644 --- a/docs/versions/README.md +++ b/docs/versions/README.md @@ -1,13 +1,18 @@ # Versioned documentation -This directory contains immutable documentation snapshots for stable Herdr releases. +This directory contains the published documentation for stable Herdr releases. -Do not edit snapshot files manually. They must match the release tag recorded in `manifest.json`. Validate them with: +Release CI creates each version from the tagged `docs/next` tree after the GitHub Release succeeds. Maintainers can correct published documentation in its version directory afterward. When a correction also applies to future releases, make the same focused change under `docs/next`; do not replace a published tree with the current draft. + +Validate the manifest and build every published version with: ```bash node website/scripts/docs-versions.mjs check +cd website && bun run build ``` -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>/` and uses the current snapshot for `/docs/` after the legacy stable-doc migration completes. `/docs/preview/` comes only from the active preview release snapshot in `docs/preview/`, never directly from `docs/next/`. +`website/scripts/prepare-docs.mjs` renders each maintained version at `/docs/<version>/` and uses the version selected by `manifest.json` for `/docs/`. Generated files under `website/src/content/docs/` are not editable sources. `/docs/preview/` comes only from the active preview release snapshot in `docs/preview/`, never directly from `docs/next/`. + +The `tag`, `commit`, and `source` fields in `manifest.json` record where release CI initially published a version. Git history records later documentation corrections. The historical backfill starts at v0.5.11, the first release that included the Astro/Starlight documentation site. |