aboutsummaryrefslogtreecommitdiff
path: root/website/README.md
blob: fd8d8ea2538dd86f062185d5717ffe484d5e24e8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# herdr website

The homepage is `index.html`. The documentation source is in `src/content/docs/` and is rendered by Astro Starlight.

```bash
bun install
bun run dev
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.