docs: fix and expand user docs #74

Merged
labrec_b merged 4 commits from docs/user-docs-improvements into main 2026-08-27 15:32:59 +02:00
4 Commits
Author SHA1 Message Date
Benjamin Labrecque 13a7681d18 fix: docs 2026-08-27 15:31:40 +02:00
Benjamin Labrecque cf46a06fbb fix: docs 2026-08-27 15:28:12 +02:00
Benjamin Labrecque 6398353871 docs: fix 2026-08-27 15:24:24 +02:00
Benjamin LabrecqueandClaude Sonnet 5 da4a19d982 docs: fix and expand user docs
- add-new-service.md: document agebd service add's actual behavior
  (required flags, that it auto-creates and pushes a
  feature/add-service-<name> branch, and the CI pipeline that push
  triggers), explain how service-specific vs external PV naming
  actually works, and correct the claim that external PVs are
  read-only in dev (unenforced: get_pv_external_class() is unused
  and there's no EPICS ACF in this repo).
- iocs_overview.md: fix TUNEFBX's copy-pasted "top up tool"
  description, merge the AGEBD-CPCL-DBPM3/DBPM3CURR duplicate,
  deduplicate the two conflicting PARAMS rows (the "PCT base
  lifetime" description actually belongs to TAUPCT), clarify that
  AGEBD-CPCL-ALH isn't a separate IOC, and add the services that
  were missing entirely (TauPCT, TuneFBy, Params, ShiftTool,
  BeamTransferChecks, all 11 OpticsFF-* beamline services).
- gui.md: warn that launching straight from a git checkout uses
  unsubstituted {{ agebd_env_suffix_upper/lower }} placeholders,
  since substitution only happens at deploy time.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01A9GjKvXCmfgJpKzbQdZ7UA
2026-08-27 15:20:10 +02:00