From d4dc897bacb520f74a4fa92a738c14d5cd02fcee Mon Sep 17 00:00:00 2001 From: idy Date: Thu, 30 Jul 2026 11:25:59 +0800 Subject: [PATCH] docs: describe compact OpenAI review report Document the visible stage verdicts and aggregate usage while clarifying that session metadata and per-stage token details remain available in folded sections. Closes #14 Generated with [Codex](https://github.com/openai) --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 342c089..b288718 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,9 @@ superseded snapshots only after a replacement upload succeeds. - Every accepted review creates three fixed Check Runs on the exact PR head: `OpenAI PR Review`, `OpenAI Issue Review`, and `OpenAI Code Review`. Each reports its own running, successful, failed, or cancelled state, while one - native `## 🤖 OpenAI PR review` report contains the combined evidence. + native `OpenAI PR Review` report contains the combined conclusion. Its + default view keeps the PR-format, Issue-design, and code/plan-conformance + verdicts visible alongside the reviewed scope and aggregate usage. - `OpenAI PR Review` checks the title, body, and native closing-Issue linkage. `OpenAI Issue Review` checks every linked Issue independently and aggregates their format and design verdict. `OpenAI Code Review` checks only code @@ -56,10 +58,11 @@ superseded snapshots only after a replacement upload succeeds. per-million-token model rate card: uncached input uses the input rate, cached input uses the cached-input rate, and output (including reasoning) uses the output rate. This is a token-derived estimate, not an API billing - ledger value. The report includes the stable PR session key, content-addressed - generation key, reviewed commit range, deterministic diff chunk count, and - per-stage usage. The stage table identifies full, incremental, reused, and - deterministic work, including a separate row for every linked Issue. + ledger value. Folded report sections retain the stable PR session key, + content-addressed generation key, reviewed commit range, deterministic diff + chunk count, and per-stage usage. The stage table identifies full, + incremental, reused, and deterministic work, including a separate row for + every linked Issue. Reused and deterministic rows consume zero model tokens. Cached-input tokens are part of input tokens, and reasoning-output tokens are part of output tokens; neither is added to the total a second time.