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 --directsteps.) - For the
deploy_orgone-shot and diagrams only: the build directory is configured per CMake configuration.
Steps
In execution order:
- 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 withcompass build --direct site skills settingsinstead.) - Deploy settings. If changing only Claude Code permissions, run
compass build --direct settingsper How do I deploy the settings?. - Deploy skills. If changing only skills, run
compass build --direct skillsper How do I deploy the skills?. - Build the manual PDF. Run
compass build --direct manualper theuser_manual_pdf_buildstory. - Verify. Run
./compass.sh site serveand open localhost to preview. Check thatllm.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
- How do I deploy all org-mode artefacts? — the
dorgtarget. - Runbooks catalogue — all runbooks.