sls/hla_framework_bd
0
1
Fork 0
Code Issues 23 Pull Requests 2 Actions Packages Projects 1 Releases Wiki Activity

Docs/user docs improvements #75

Merged
labrec_b merged 7 commits from docs/user-docs-improvements into main 2026-08-27 15:47:43 +02:00
Conversation 0 Commits 7 Files Changed 3
+9 -9
labrec_b commented 2026-08-27 15:47:03 +02:00
Member
Copy Link
Copy Source
No description provided.
labrec_b added 7 commits 2026-08-27 15:47:03 +02:00
docs: fix and expand user docs da4a19d982 
- 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
docs: fix 6398353871
fix: docs cf46a06fbb
fix: docs 13a7681d18
docs: point cross-repo links to gitea instead of relative paths 99b5cd9e1e 
Docs are rendered on a separate site (zensical), which only serves the
docs/ tree, so relative links out to config/services_registry.yml were
broken there. Point them at the Gitea file view instead. Left the
add-new-service.md -> ioc/iocs_overview.md link relative since it stays
within the docs tree.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01A9GjKvXCmfgJpKzbQdZ7UA
docs: gui b0bd817428
merge main dc65f6f6d8
labrec_b merged commit 132f924e6b into main 2026-08-27 15:47:43 +02:00
Sign in to join this conversation.
Reviewers
No Reviewers
Labels
No items
No labels
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
armborst_f (armborst_f) kallestrup_j (kallestrup_j) labrec_b (labrec_b) maeder (maeder)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: sls/hla_framework_bd#75