Commit cc3a44b
docs(benchmarks): add design doc for #3601 summary-table improvements
## Summary
Adds the design doc for the benchmark **summary-table improvements**
shipped in **#3627** (issue **#3601**). The doc was written during that
PR's design phase but accidentally left untracked, so it never landed.
This matches the established `docs/superpowers/specs/` convention —
prior features committed their design docs the same way (e.g.
`2026-05-21-otel-node-renderer-design.md` from #3382,
`2026-05-25-main-ci-release-guard-design.md` from #3407). Status header
updated to `Implemented (PR #3627)` to mirror those.
## Why keep it
The merged code + comments capture the *what*; this doc captures the
*why these and not the alternatives* — the decision rationale that code
comments don't:
- inline baseline + delta **in the same cell** (vs column-doubling)
- **one perf link per benchmark name** (vs per-metric-cell)
- send `p90_latency` to Bencher **boundary-less** (recorded for a
baseline, never alerted)
- **drop the Fail% column but keep the `failed_pct` threshold** (alert
safety net)
…plus the CI-only verification risks that were called out before the
first live benchmark run.
## Notes
- **Docs-only.** No code, no behavior change.
- Base: freshly fetched `main`. Not auto-closing anything — issue #3601
was already closed by #3627; this just backfills the record.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
<!-- CURSOR_SUMMARY -->
---
> [!NOTE]
> **Low Risk**
> Documentation-only addition with no code or CI behavior changes.
>
> **Overview**
> Adds
**`docs/superpowers/specs/2026-06-04-benchmark-table-improvements-design.md`**,
backfilling the design record for issue **#3601** / implementation
**#3627** under the existing `docs/superpowers/specs/` pattern.
>
> The doc is marked **Implemented (PR #3627)** and spells out the
product choices that drove the merged benchmark table work: inline
baseline + delta in metric cells, one Bencher perf link per benchmark
name, boundary-less `p90_latency` with value-only fallback, and hiding
Fail% while keeping `failed_pct` alerting. It also documents cell
rendering rules, the intended code touchpoints, and CI-only verification
risks.
>
> **Docs-only** — no application or benchmark runtime behavior changes
in this PR.
>
> <sup>Reviewed by [Cursor Bugbot](https://cursor.com/bugbot) for commit
08448d7. Bugbot is set up for automated
code reviews on this repo. Configure
[here](https://www.cursor.com/dashboard/bugbot).</sup>
<!-- /CURSOR_SUMMARY -->
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Documentation**
* Marked the benchmark table spec as implemented and linked related
issues.
* Defined four visible behaviors: inline baseline+delta in metric cells;
one performance link per benchmark; p90 shown from a boundary-less p90
latency measure with value-only fallback when no baseline; removed
visible Fail% column (thresholds still trigger alerts).
* Clarified cell rendering rules (nil/non-numeric handling, rounding,
significance markers, arrows vs red/green indicators) and included a
final example table.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
---------
Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>1 parent e26d659 commit cc3a44b
1 file changed
Lines changed: 107 additions & 0 deletions
Lines changed: 107 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
0 commit comments