Deploy the documentation site

Table of Contents

This page documents a runbook — a named, repeatable composition of recipes and skills for a complete multi-step procedure. Each step references a recipe or skill by id-link.

Goal

Build and deploy all ORE Studio documentation artefacts: product site, Claude Code settings, skills, PlantUML diagrams, and manual PDF.

Preconditions

  • Emacs is on PATH. (Sufficient for the compass build --direct steps.)
  • For the deploy_org one-shot and diagrams only: the build directory is configured per CMake configuration.

Steps

In execution order:

  1. Deploy org-mode artefacts. Run dorg (cmake --build ... --target deploy_org) to rebuild the site, settings, skills, and diagrams in one shot. See How do I deploy all org-mode artefacts?. (This aggregate target includes the diagrams, which need cmake; in a light environment build the individual artefacts with compass build --direct site skills settings instead.)
  2. Deploy settings. If changing only Claude Code permissions, run compass build --direct settings per How do I deploy the settings?.
  3. Deploy skills. If changing only skills, run compass build --direct skills per How do I deploy the skills?.
  4. Build the manual PDF. Run compass build --direct manual per the user_manual_pdf_build story.
  5. Verify. Run ./compass.sh site serve and open localhost to preview. Check that llm.html, runbooks.html, and the LLMs nav entry render correctly.

Postconditions

  • Site builds cleanly with no errors.
  • All LLM artefacts (settings, skills, diagrams) are deployed.
  • Manual PDF is generated.
  • Local preview renders correctly.

See also

Emacs 29.1 (Org mode 9.6.6)