diff options
| author | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-09-01 14:48:45 +0300 |
|---|---|---|
| committer | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-09-01 14:48:45 +0300 |
| commit | 8a6d697308162874a236c84aac0b0f8c7ac01f83 (patch) | |
| tree | ed7dc7e8c6f50d66bde721fae78576aede929f66 /docs | |
| parent | b54a78aa510b87d1e3b56c619b72eaeb59e4a2a1 (diff) | |
refactor: separate website presentation from runtime
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/preview/README.md | 6 | ||||
| -rw-r--r-- | docs/versions/README.md | 7 |
2 files changed, 6 insertions, 7 deletions
diff --git a/docs/preview/README.md b/docs/preview/README.md index f8ba2c6a..bd7c4bce 100644 --- a/docs/preview/README.md +++ b/docs/preview/README.md @@ -1,9 +1,9 @@ # Preview documentation -`website/` is the committed documentation snapshot for the active preview release in `website/preview.json`. +`website/` is the committed documentation snapshot for the active preview release recorded in `distribution/preview.json`. -Do not edit it manually. Preview CI replaces it from the selected commit's `docs/next/website` tree and commits the snapshot together with `website/preview.json`. Validate it with: +Do not edit it manually. Preview CI replaces it from the selected commit's `docs/next/website` tree and commits the snapshot together with `distribution/preview.json`. Validate it with: ```bash -node website/scripts/docs-preview.mjs check +node scripts/docs/preview.mjs check ``` diff --git a/docs/versions/README.md b/docs/versions/README.md index 42ca1c69..502d1d43 100644 --- a/docs/versions/README.md +++ b/docs/versions/README.md @@ -4,14 +4,13 @@ This directory contains the published documentation for stable Herdr releases. 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: +Validate every published version with: ```bash -node website/scripts/docs-versions.mjs check -cd website && bun run build +node scripts/docs/versions.mjs check ``` -`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 private website renders each maintained version at `/docs/<version>/`, uses the version selected by `manifest.json` for `/docs/`, and renders the active preview snapshot at `/docs/preview/`. The source snapshots in this directory remain public release evidence; the private repository owns only their presentation. The `tag`, `commit`, and `source` fields in `manifest.json` record where release CI initially published a version. Git history records later documentation corrections. |