Skip to main content

Runbook: Docusaurus docs site (docs.ehxlabs.xyz)

Milestone: M5.11.6 · Issues: ehx-kb#45, ehx-web#64

Architecture​

PieceLocation
Editorial sourceehx-kb/docs/*.md (this tree)
Site generatorehx-kb/website/ (Docusaurus 3)
Build outputehx-kb/website/build/
Public URLhttps://docs.ehxlabs.xyz (Caddy file_server, not GitHub redirect)

Content backlog (user-facing guides): milestone-5-11-docs-content.md.

Build locally​

cd ehx-kb
./scripts/build-docs-site.sh

Preview:

cd website && npm run serve

Deploy (production)​

  1. Build on the host (or CI artifact): 
    cd /path/to/ehx-kb && ./scripts/build-docs-site.sh
  2. Ensure ehx-web compose mounts the build:
    • Volume: ../ehx-kb/website/build:/srv/docusaurus:ro
  3. Recreate Caddy after Caddyfile change: 
    cd ehx-web && docker compose up -d caddy --force-recreate
  4. Verify: https://docs.ehxlabs.xyz shows Docusaurus nav (not Next link hub).

Edit ehx-kb/website/sidebars.js when adding runbooks to the public nav. Files can live in docs/ without being listed (omitted from sidebar).