Files
bfe-core1106-sdk/docs/workflows/freshness-contract.md
T
BFE Engineering 42fb386f60 docs: ASCII typography and style normalization across all repo text
Replace every em dash with real punctuation (rewrites, not hyphen swaps)
in docs, code comments, scripts, configs, and the port records; convert
en dashes, curly quotes, ellipsis glyphs, arrows, and section signs to
ASCII; drop machine-writing tell phrases from living docs. ADR titles
now use a colon. The M2 bring-up DTS model string carried an em dash
into the patch series and its record echoes; fixed at both, and the full
series re-verified to apply cleanly onto pristine 6.18.46. One comment
in freshness.h deliberately names the em dash glyph the UI renders as
the unknown mark; that is data, kept as prose naming it.

Verified: cargo tests (sim, config-lint, rs485-bridge), shellcheck,
both driver MC/DC harnesses, patches-apply.
2026-08-31 12:31:27 -06:00

20 lines
513 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
```