${title}
' - echo 'Auto-generated from the hyperhive flake. Source: nix/docs/default.nix.
' - cmark-gfm ${doc.optionsCommonMark} - echo 'diff --git a/CLAUDE.md b/CLAUDE.md index 78622cbe..d1d682d0 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -348,10 +348,10 @@ nix/ — weston + VNC backend systemd unit; writes /etc/hyperhive/gui.json (vnc_port + auth) for the harness WebSocket relay (/screen/ws) - docs/ HTML+MD options reference (host + agent); built - default.nix via `nix build .#docs` → static site - style.css (`index.html`, `host.html`, `agent.html`, - `host.md`, `agent.md`); rendered by cmark-gfm + docs/ markdown options reference (host + agent); + default.nix `nix build .#docs` → `index.md` + `host.md` + + `agent.md` (CommonMark from nixosOptionsDoc). + HTML+CSS rendered downstream by the website repo forge-theme/theme-catppuccin-vibec0re.css Catppuccin Mocha forge theme docs/ diff --git a/docs/gotchas.md b/docs/gotchas.md index bf483e2a..9211dad4 100644 --- a/docs/gotchas.md +++ b/docs/gotchas.md @@ -286,29 +286,24 @@ inputs stay out of the eval) and `agentEval` (reuses the already-evaluated `agent-base` container config so the per-agent options tree is identical to what a real agent container sees). -Three output trees consumed by `flake.nix`: +Three output trees consumed by `flake.nix`, all **markdown**: - `docs-host` — operator-facing host module options (`services.hyperhive.*`) - `docs-agent` — per-agent harness options (`hyperhive.*` declared in `nix/templates/harness-base.nix`) -- `docs` — bundled static site (`index.html` + `host.html` + - `agent.html`, plus `.md` source-of-truth versions of each - options page) +- `docs` — bundle of `index.md` + `host.md` + `agent.md` -Rendering pipeline: +Pipeline: -- CommonMark from `nixosOptionsDoc.optionsCommonMark` — source of - truth, kept as `.md` in the bundle. -- HTML via `pkgs.cmark-gfm` over the CommonMark, wrapped in a - minimal inline-CSS template. `cmark-gfm` (not plain `cmark`) so - any future tables / autolinks Just Work without revisiting. -- Inline `' - echo '' - echo '
' - echo '' - echo 'Auto-generated from the hyperhive flake. Source: nix/docs/default.nix.
' - cmark-gfm ${doc.optionsCommonMark} - echo '