OXYGENHUB

docs/reports.md: a report's free-form [context] (a budget, a frame rate) 260c33b4b6c4

refs #127
Author
Andy McCall @andymccall <[email protected]>
When
· 2026-10-10 23:35 UTC
Signature
✔ signed by Andy McCall
Hash
260c33b4b6c4d8d23000b3d146fed71ec748a95dc6fc058119ed2a7c1627d31f
Depends on
50d93fa443dc
Depended on by
nothing yet
In bookmarks
api-unknown-fields cancel-landed-runs clear-waiting close-proposal-140 diffusion-pin-bookmark draft-ready image-check job-waits main oh-comment-body-file proposal-list-fast run-one-job wiki-says-so
In tags
v0.4.2 v0.5.0 v0.5.1 v0.5.2 v0.6.0 v0.6.1 v0.7.0 v0.8.0 v0.9.0 v0.9.1 v0.9.11 v0.9.15 v0.9.16 v0.9.19 v0.9.2 v0.9.20 v0.9.21 v0.9.22 v0.9.23 v0.9.24 v0.9.3 v0.9.4 v0.9.5 v0.9.6 v0.9.7 v0.9.8 v0.9.9
Edits
2 atoms, 0 tree operations, 1 file

Browse the tree at this change

show whitespace changes
modified docs/reports.md +8 −0
… 
31 unchanged lines
32 32 
median_frame_ms = { value = 16.4, unit = "ms", better = "lower" }
33 33 
p99_frame_ms    = { value = 18.1, unit = "ms", better = "lower", fail_above = 20 }
34 34 
scenes          = { value = 12 }
35 + 

    

  
    

      
      36
      +
      
[context]                      # free-form, shown with the report

    

  
    

      
      37
      +
      
target_fps    = 60

    

  
    

      
      38
      +
      
budget_cycles = 133333

    

  
    

      35
      39
       
      
```

    

  
    

      36
      40
       
      

    

  
    

      37
      41
       
      
- **Built-in kinds** name their data file and need no page:

    

  
    

      
      
      …
      
3 unchanged lines

    

  
    

      41
      45
       
      
  failed, skipped).

    

  
    

      42
      46
       
      
- **`performance`** is a page with metrics, as above.

    

  
    

      43
      47
       
      
- **`custom`** is a page, metrics optional.

    

  
    

      
      48
      +
      
- **`[context]`** is free-form: what a reader needs to read the numbers,

    

  
    

      
      49
      +
      
  shown with the report and kept per run, such as a performance budget

    

  
    

      
      50
      +
      
  (`target_fps = 30`, `budget_cycles = 268800`). The hub assumes no frame

    

  
    

      
      51
      +
      
  rate or budget; each report's metrics and thresholds carry their own.

    

  
    

      44
      52
       
      
- **A metric** is a number with an optional `unit`, `better` (`higher` or

    

  
    

      45
      53
       
      
  `lower`, for colouring changes) and `fail_above` / `fail_below`, which

    

  
    

      46
      54
       
      
  set a check on the change (§5).

    

  
    

      
      
      …
      
125 unchanged lines