aboutsummaryrefslogtreecommitdiff
path: root/docs/preview/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/preview/README.md')
-rw-r--r--docs/preview/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/preview/README.md b/docs/preview/README.md
new file mode 100644
index 00000000..f8ba2c6a
--- /dev/null
+++ b/docs/preview/README.md
@@ -0,0 +1,9 @@
+# Preview documentation
+
+`website/` is the committed documentation snapshot for the active preview release in `website/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:
+
+```bash
+node website/scripts/docs-preview.mjs check
+```