Files
csaxs_bec/docs/developer/developer.md
Mirko HollerandClaude Sonnet 5 edbd890700
CI for csaxs_bec / test (push) Successful in 2m43s
docs(developer): document the vision pipeline architecture
Generic reference for VisionInterface/SampleVisionMonitor (the three-layer
camera-processing architecture, ROI cropping, position-blind shape scoring
vs. position_tolerance_px, and reading diagnostic_image), plus the
device_manager-injection pitfall for any future PSIDeviceBase subclass that
needs to resolve sibling devices -- written up the same way as the existing
lamni_smear_architecture.md.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01C9zgK28uPoZWJFkJWV4P1G
2026-09-06 20:14:53 -03:00

58 lines
1.1 KiB
Markdown

(developer)=
# Developer
Information for developers and maintainers of the cSAXS beamline documentation and software.
```{toctree}
---
maxdepth: 2
hidden: true
---
editing_docs
lamni_smear_architecture
vision_pipeline_architecture
```
***
````{grid} 2
:gutter: 5
```{grid-item-card}
:link: developer.editing_docs
:link-type: ref
:img-top: /assets/index_contribute.svg
:text-align: center
:class-item: index-card
## Editing the documentation
Conventions for writing these MyST/Sphinx docs and how changes go live on Read the Docs.
```
```{grid-item-card}
:link: developer.lamni_smear_architecture
:link-type: ref
:text-align: center
:class-item: index-card
## LamNI smear aid architecture
Device/ipython-client/GUI widget interfaces for the smear rotation-center calibration aid, and the `bw-generate-cli` regeneration pitfall.
```
```{grid-item-card}
:link: developer.vision_pipeline
:link-type: ref
:text-align: center
:class-item: index-card
## Vision pipeline architecture
The generic `VisionInterface`/`SampleVisionMonitor` camera-processing layer, the `PreviewSignal` rpc_access gotcha, and the `device_manager` injection pitfall.
```
````