blob: ceb872afcecd9f13f0efedb78acd81c9e4b4c53f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
|
# herdr website
The homepage is `index.html`. Astro Starlight renders the documentation.
```bash
bun install
bun run dev # render the unpublished docs/next draft locally
bun run build # render only published stable and preview snapshots
bun run build:draft # validate the unpublished draft
```
The build output is `dist/`. Configure Cloudflare Pages to use `website` as the project root and publish `dist`.
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 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 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:
```bash
node website/scripts/docs-preview.mjs snapshot <commit>
node website/scripts/docs-preview.mjs check
```
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>
node website/scripts/docs-versions.mjs check
```
|
