Documentation

A Guide instructs, a Reference lists. Start with the guide that matches where your board is; the references are there when a guide sends you to one.

Guides

• Install — putting this on your own board
• Upgrading from stock — from the firmware it shipped with, and what to expect on the way
• Recover a bad flash — what to do when it goes wrong
• Monitor it — the metrics port, a scrape config, the dashboard
• Developing — build it, and iterate without cutting a release

Reference

• The API — OpenAPI 3.1, served by the board; every operation on one page
• Command line — tpi, which reaches every endpoint above
• Metrics — every family the board exposes
• Upstream vs this fork — row by row, with evidence, including where upstream is ahead
• The factory firmware — what a board ships with, captured
• What is and isn't fixed — the honest list, with tickets
• Changelog — every release of every component