odin-detector/odin-data

View on GitHub
docs/developer/index.md

Summary

Maintainability
Test Coverage
# Developer Guide

::::{grid} 2
:gutter: 4

:::{grid-item-card} {material-regular}`directions_run;3em` [Tutorials](./tutorials/index)

---

- [Write Odin support for a detector](./tutorials/write-detector-support)

+++

Tutorials for getting up and running as a developer

:::

:::{grid-item-card} {material-regular}`task;3em` [How-To Guides](./how-to/index)

---

- [Implement a FrameDecoder](./how-to/frame-decoder)
- [Implement a FrameProcessorPlugin](./how-to/frame-processor-plugin)
- [Implement a FrameSimulatorPlugin](./how-to/frame-simulator-plugin)

+++

Practical step-by-step guides for day-to-day dev tasks

:::

:::{grid-item-card} {material-regular}`apartment;3em` [Explanations](./explanations/index)

---

- [Design Decisions](./explanations/design-decisions)

+++

Explanations of how and why the architecture is why it is

:::

:::{grid-item-card} {material-regular}`description;3em` [Reference](./reference/index)

---

- [FrameReceiver API](./reference/api/frame-receiver)
- [FrameProcessor API](./reference/api/frame-processor)
- [FrameSimulator API](./reference/api/frame-simulator)
- [Live View Specification](./reference/design-docs/live-view-spec)

+++

Technical reference material, internal API docs and development guidelines

:::

::::