leonarski_f
9c543f60b6
The home page introduces Rugnux, the viewer and the acquisition system in three cards, with the licence stated once, and the sidebar is regrouped by program: what a user of Rugnux or the viewer needs comes first, and the algorithms, formats, interfaces, hardware and FPGA pages sit under one collapsed "Technical reference" hub (TECHNICAL.md). No page moves, so every existing URL stays. Download pages (RUGNUX_DOWNLOAD.md, VIEWER_DOWNLOAD.md) are rendered by a small Sphinx extension (docs/_ext/jfjoch_downloads.py) from the `release` in conf.py, which update_version.sh rewrites, so no version string on them is maintained by hand; a script then asks the Gitea API for the newest published release and repoints the buttons at its assets, naming any archive that release does not carry. Without network access the build-time links stand. JUNGFRAUJOCH.md is the landing page of the acquisition side with its install pointers. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015CeEGgpKdfkCTJb3YNMJcu (cherry picked from commit 050442592504ce879dc51d78b6d3d1c58268a800)
976 B
976 B
Technical reference
The pages that describe how things work rather than how to use them: the algorithms behind the analysis, the file formats and streams, the programming interfaces, the hardware and the FPGA design. Nothing here is needed to run Rugnux or the viewer; all of it is needed to build on them.
:caption: Data analysis
:maxdepth: 1
CPU_DATA_ANALYSIS
CPU_DATA_ANALYSIS_IMAGE
CPU_DATA_ANALYSIS_INDEXING
CPU_DATA_ANALYSIS_INTEGRATION
CPU_DATA_ANALYSIS_DECISIONS
GPU_DATA_ANALYSIS
DETECTOR_GEOMETRY
RUGNUX_BENCHMARKING
EXTERNAL_TEST_DATA
EXTERNAL_TEST_DATA_STILLS
:caption: Formats and interfaces
:maxdepth: 1
HDF5
PIXEL_MASK
IMAGE_STREAM
CBOR
OPENAPI
OPENAPI_SPECS
:caption: Hardware and FPGA
:maxdepth: 1
HARDWARE
SOFTWARE
DETECTORS
FPGA
FPGA_DESIGN
FPGA_DATA_ANALYSIS
FPGA_NETWORK
FPGA_PCIE_DRIVER
FPGA_SETTINGS
FPGA_LICENSE
:caption: Development
:maxdepth: 1
TESTS
VERSIONING
SECURITY