Skip to content

docs: spec the HTML validation report#72

Merged
dadachi merged 1 commit into
mainfrom
docs/validation-report-spec
May 22, 2026
Merged

docs: spec the HTML validation report#72
dadachi merged 1 commit into
mainfrom
docs/validation-report-spec

Conversation

@dadachi
Copy link
Copy Markdown
Contributor

@dadachi dadachi commented May 22, 2026

What

Adds docs/validation-report.md — the design spec for a self-contained HTML validation report (plus a machine-readable report.json) emitted at the end of every agent run.

Highlights

  • Key finding: runJudge already computes per-layer detail (Layer 1 findings, Layer 2 command/duration/stderrTail, reviewer diffs) but collapses it into a single summary string. The report cannot be a pure post-process of today's JudgeResult — widening what survives the run is step 1 of implementation.
  • Approach: emit a RunReport as report.json; renderReport(report) → string is a pure, golden-file-testable function. Self-contained single HTML file by default (base64-embedded screenshots, inlined CSS, no JS framework / no network).
  • Includes the full RunReport data model, src/report/ layout, report sections (platform×layer matrix, findings tables, screenshot filmstrip, rubric rationales, rename-plan appendix), CLI flags, MCP integration, testing plan, and a 7-step implementation order.

Implementation lands in a follow-up PR (step 1: widen runJudge to retain per-layer detail).

🤖 Generated with Claude Code

Specs a self-contained HTML report + machine-readable report.json
emitted at the end of every run, summarizing all validation layers
and the reviewer with embedded screenshots.

Flags the key structural finding: runJudge already computes per-layer
detail (Layer 1 findings, Layer 2 command/duration/stderr, reviewer
diffs) but collapses it to a summary string, so the report cannot be a
pure post-process of today's JudgeResult — widening what survives the
run is step 1. Includes the RunReport data model, src/report/ layout,
CLI flags, MCP integration, testing approach, and implementation order.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@dadachi dadachi merged commit 9b39ab5 into main May 22, 2026
1 check passed
@dadachi dadachi deleted the docs/validation-report-spec branch May 22, 2026 09:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant