diff options
Diffstat (limited to 'website/README.md')
| -rw-r--r-- | website/README.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/website/README.md b/website/README.md index a511a861..ceb872af 100644 --- a/website/README.md +++ b/website/README.md @@ -15,9 +15,9 @@ Documentation has three lifecycle states: - `../docs/next/website/` is the committed, author-edited draft. Production builds never read it. - `../docs/preview/website/` is the latest preview release snapshot, rendered at `/docs/preview/`. -- `../docs/versions/<version>/website/` contains immutable stable release snapshots, rendered at `/docs/<version>/`. +- `../docs/versions/<version>/website/` contains maintained stable-release documentation, rendered at `/docs/<version>/`. Release CI seeds a new version from its tag; later factual corrections are made directly in that version directory and mirrored to `docs/next` when they also apply to future releases. -The current stable site temporarily remains tracked under `src/content/docs/` because it contains post-v0.7.5 documentation corrections. The next stable release switches `docs/versions/manifest.json` to snapshot-backed stable docs and removes that legacy copy. From then on, `src/content/docs/` is entirely generated and ignored. +The version selected by `docs/versions/manifest.json` is also rendered at `/docs/`. `src/content/docs/` is entirely generated and ignored. Preview CI snapshots the selected commit and updates `preview.json` in one commit: @@ -26,7 +26,7 @@ node website/scripts/docs-preview.mjs snapshot <commit> node website/scripts/docs-preview.mjs check ``` -Stable release CI snapshots the exact tag after the GitHub Release succeeds: +Stable release CI seeds a new maintained version from the exact tag after the GitHub Release succeeds: ```bash node website/scripts/docs-versions.mjs publish <tag> |