diff options
Diffstat (limited to 'website/README.md')
| -rw-r--r-- | website/README.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/website/README.md b/website/README.md index 36dfb12d..fd8d8ea2 100644 --- a/website/README.md +++ b/website/README.md @@ -9,3 +9,13 @@ bun run build ``` The build output is `dist/`. Configure Cloudflare Pages to use `website` as the project root and publish `dist`. + +Stable docs live in `src/content/docs/`. Unreleased docs live in `../docs/next/website/src/content/docs/` and are generated at `/docs/preview/`. Immutable release snapshots live in `../docs/versions/` and are generated at `/docs/<version>/`. + +Do not promote docs manually before a release. After the GitHub Release succeeds, release CI runs: + +```bash +node website/scripts/docs-versions.mjs publish <tag> +``` + +This snapshots the tagged next docs and promotes the same tagged content to stable before the website deploy. Use `node website/scripts/docs-versions.mjs check` to validate committed snapshots against their release tags. |