hydrate.sh documentation

Source for docs.hydrate.sh — guides, concepts, and the v1 API reference. Built with Astro Starlight.

Develop

bun install
bun run dev      # local dev server
bun run build    # static build into ./dist
bun run preview  # preview the built site

Prose docs live in src/content/docs/. Site config (title, nav, plugins) is in astro.config.mjs.

API reference

The /api/v1/ section is generated by starlight-openapi from openapi.json at the repo root.

Keeping the API reference in sync

openapi.json is a vendored copy of backend/openapi.json from the application repo. It is kept current by CI: on merge there, a workflow pushes the regenerated spec to this repo's main, which triggers a redeploy. Do not hand-edit openapi.json — edit the API in the app repo and let the sync run.

Deployment

main auto-deploys to GitHub Pages via .github/workflows/deploy.yml. The custom domain is pinned by public/CNAME (docs.hydrate.sh).