Files
bfe-core1106-sdk/docs/workflows/freshness-contract.md
T
BFE Engineering c756622c96 docs: reposition as the 86 Panel development environment
The repo's documentation framed it as a support repo for one product
(WardenOS). Since going public the real audience is anyone with a Luckfox
Pico 86 Panel: a maintained 6.18 kernel, an off-device development loop,
and a device simulator that exist nowhere else for this board. Reframe the
README and top-level docs board-first, with WardenOS documented as the
downstream consumer it is (ADR-0008).

Also an editorial pass over the whole doc set:
- every H1/H2 is now a short title, not a sentence (ADRs, qemu/, patches/,
  drivers/, architecture, NPU feasibility, config-lint, payload); workflow
  flowchart titles fixed at the source in tools/flowgen.py and regenerated
  with fresh bench numbers
- README Quick Start commands verified against the scripts; requirements
  corrected (curl, bare python, gcc >= 14) and the MC/DC gate added as a
  step (run green locally on gcc 14.2)
- dropped the 'needs python (not python3)' vendor dig: build-kernel.sh
  inherited the same requirement (filed #10 to remove it)
- glossed MC/DC and HPMCU on first use; marked the tests/uboot-ab
  reference as flare-edge; deduplicated the three-simulator list into the
  root README table
2026-08-30 22:19:12 -06:00

20 lines
516 B
Markdown

# UI Freshness Contract
> **Outcome tested:** The UI never shows a stale number: it holds briefly, then marks unknown.
**Coverage**: freshness.c — 66/66 conditions, 100% MC/DC (CI-enforced)
```mermaid
flowchart TD
A[produce] --> B{result}
B -- OK --> V[render value, save last]
B -- SAME --> C{showing unknown?}
C -- yes --> V
C -- no --> N[no change]
B -- UNKNOWN --> D{ever had a value?}
D -- no --> U[render UNKNOWN mark]
D -- yes --> E{age > max_stale?}
E -- yes --> U
E -- no --> N
```