bec/csaxs_bec
0
0
Fork 2
Code Issues 17 Pull Requests 1 Actions Packages Projects Releases Wiki Activity
984 Commits 99 Branches 0 Tags
d97692e090edd7f0934aebf995b0e447d22dabf0
Commit Graph
3 Commits
Author SHA1 Message Date
x01dcandClaude Sonnet 5 831e75675c docs(LamNI): document smear aid architecture and camera/GUI interfaces 
Add docs/developer/lamni_smear_architecture.md covering the three-tier
device/ipython-client/GUI architecture this feature exercises: the
camera's two PreviewSignal channels (image vs smear_preview) and why
composite pushes needed their own channel, XRayEye.set_live_view_signal
and exactly when the caller must switch it back, the sweep algorithm
(non-blocking mv() + ScanReport.status polling + max-projection), and
the bw-generate-cli regeneration step required whenever a plugin
widget's USER_ACCESS changes (the cause of this session's confusing
AttributeError even after a full client/GUI restart).

Also expand the user-facing description in lamni.md with a note on the
live-updating composite display and a cross-reference to the new
developer page.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
 2026-07-24 16:08:01 +02:00
menzelandClaude Opus 4.8 ba27af5a71 docs(developer): add "How to edit these docs" contributor guide
CI for csaxs_bec / test (pull_request) Successful in 1m34s
Details
Read the Docs Deploy Trigger / trigger-rtd-webhook (push) Successful in 3s
Details
CI for csaxs_bec / test (push) Successful in 1m35s
Details 
Add docs/developer/editing_docs.md documenting the MyST/Sphinx conventions
for this site: page anatomy (cross-reference label + single H1), language-
tagged code fences, admonitions, cross-references, the {download} role for
non-image files, the {figure} directive, and how to add a page to a toctree.
Also covers local preview, the merge-then-RTD-build flow, and pitfalls
(broken refs are warnings, public visibility, placeholder consistency).

Turn the empty developer.md stub into a landing page with a toctree and a
card linking to the new guide.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
 2026-06-24 18:19:39 +02:00
wakonig_k 805d4b5a13 docs: add readthedocs configuration 2024-11-05 22:08:49 +01:00