Developer docs

Developer docs

How roro9stack is built, debugged, tested and released: the Debug Console, the build, the decisions and the plans, from the repository's own documents.

The firmware is open source (GPL-3.0) and lives on Gitea. It is built for one device, the M5Stack Cardputer ADV with the Cap LoRa-1262, and it is built to be worked on without touching the device: install a build over Wi-Fi, read its console, press its keys, take screenshots of it, copy files to and from its SD card, and fetch its crash dumps, all from a PC on the same network. The first section is about exactly that.

Some of these pages are written by hand. The rest are generated from the repository's own documents (the decisions, the milestone plans, the README and the firmware's own help text), so they are never out of date: each says which file it comes from.

3 pages02

Build, test and release

Building the firmware, running the tests, flashing a device, and what happens between a commit and a release.

9 pages03

Decisions

The architecture decision records: why the firmware is built the way it is, and what each choice costs. Generated from docs/adr/ in the repository.

8 pages04

Milestones

The plan of each stretch of work: the goal, the decisions made in the design round, what done means, and what was measured. Generated from docs/milestones/ in the repository.