From 29113aff39713356c6bbbfb8b0b0034ca3696173 Mon Sep 17 00:00:00 2001 From: ydflow <314143294+ydflow@users.noreply.github.com> Date: Mon, 28 Sep 2026 09:34:51 +0800 Subject: [PATCH 1/2] docs(cli-reference): list the manifest status values in the status field The status field table listed only success / completed_with_warnings / completed_with_errors / skipped. Those four are the pre-manifest path; every review run that produced a manifest reports the manifest's terminal state instead (complete / partial / failed / skipped), so the documented enum was missing the values an actual run emits. Document both paths and note that skipped also covers the no-supported-files case. Synced across all five locales. --- pages/src/content/docs/en/cli-reference.md | 2 +- pages/src/content/docs/ja/cli-reference.md | 2 +- pages/src/content/docs/ko/cli-reference.md | 2 +- pages/src/content/docs/ru/cli-reference.md | 2 +- pages/src/content/docs/zh/cli-reference.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/pages/src/content/docs/en/cli-reference.md b/pages/src/content/docs/en/cli-reference.md index d14cdcfc3..d223ea3ac 100644 --- a/pages/src/content/docs/en/cli-reference.md +++ b/pages/src/content/docs/en/cli-reference.md @@ -319,7 +319,7 @@ Top-level fields: | Field | Notes | |---|---| -| `status` | `success`, `completed_with_warnings`, `completed_with_errors`, or `skipped`. | +| `status` | `complete`, `partial`, `failed`, `skipped` (from the run manifest), or `success`, `completed_with_warnings`, `completed_with_errors` on the pre-manifest path. `skipped` also covers the no-supported-files case. | | `llm` | Resolved LLM identity. The normalized `model` is always present; `provider` is present only for a named configured provider. | | `message` | Optional. Human-readable summary, e.g. `"No comments generated. Looks good to me."`. | | `summary` | Optional. Run aggregates: `files_reviewed`, `comments`, `total_tokens`, `input_tokens`, `output_tokens`, `cache_read_tokens` (omitempty), `cache_write_tokens` (omitempty), `elapsed`. Omitted for `skipped` runs. | diff --git a/pages/src/content/docs/ja/cli-reference.md b/pages/src/content/docs/ja/cli-reference.md index 088d2ad28..db3470a00 100644 --- a/pages/src/content/docs/ja/cli-reference.md +++ b/pages/src/content/docs/ja/cli-reference.md @@ -300,7 +300,7 @@ ocr review --format json | jq .summary # stdout は単一の JSON ドキュメ | フィールド | 説明 | |---|---| -| `status` | `success`、`completed_with_warnings`、`completed_with_errors`、または `skipped`。 | +| `status` | `complete`、`partial`、`failed`、`skipped`（実行マニフェスト由来）、または `success`、`completed_with_warnings`、`completed_with_errors`（マニフェスト以前のパス）。`skipped` はレビュー対象ファイルがない場合にも使われます。 | | `llm` | 解決された LLM の識別情報。正規化済みの `model` は常に含まれ、`provider` は名前付きの設定済み provider の場合だけ含まれます。 | | `message` | 任意。人間が読みやすいサマリー（例: `"No comments generated. Looks good to me."`）。 | | `summary` | 任意。実行の集計: `files_reviewed`、`comments`、`total_tokens`、`input_tokens`、`output_tokens`、`cache_read_tokens`（omitempty）、`cache_write_tokens`（omitempty）、`elapsed`。`skipped` の実行時は省略されます。 | diff --git a/pages/src/content/docs/ko/cli-reference.md b/pages/src/content/docs/ko/cli-reference.md index 4572a2d10..3cd4d5c0f 100644 --- a/pages/src/content/docs/ko/cli-reference.md +++ b/pages/src/content/docs/ko/cli-reference.md @@ -313,7 +313,7 @@ ocr review --format json | jq .summary # stdout은 JSON 문서 하나입니다 | 필드 | 설명 | |---|---| -| `status` | `success`, `completed_with_warnings`, `completed_with_errors`, `skipped` 중 하나입니다. | +| `status` | `complete`, `partial`, `failed`, `skipped`(실행 매니페스트 기준) 또는 `success`, `completed_with_warnings`, `completed_with_errors`(매니페스트 이전 경로). `skipped`는 리뷰할 파일이 없는 경우에도 사용됩니다. | | `llm` | 해석된 LLM 정보입니다. 정규화한 `model`은 항상 있고, `provider`는 이름이 있는 설정된 프로바이더일 때만 나옵니다. | | `message` | 선택. 사람이 읽는 요약입니다(예: `"No comments generated. Looks good to me."`). | | `summary` | 선택. 실행 집계입니다: `files_reviewed`, `comments`, `total_tokens`, `input_tokens`, `output_tokens`, `cache_read_tokens`(omitempty), `cache_write_tokens`(omitempty), `elapsed`. `skipped` 실행에서는 나오지 않습니다. | diff --git a/pages/src/content/docs/ru/cli-reference.md b/pages/src/content/docs/ru/cli-reference.md index dbcf1be2a..68de7fafd 100644 --- a/pages/src/content/docs/ru/cli-reference.md +++ b/pages/src/content/docs/ru/cli-reference.md @@ -304,7 +304,7 @@ ocr review --format json | jq .summary # stdout — единый JSON-доку | Поле | Примечания | |---|---| -| `status` | `success`, `completed_with_warnings`, `completed_with_errors` или `skipped`. | +| `status` | `complete`, `partial`, `failed`, `skipped` (из манифеста запуска) или `success`, `completed_with_warnings`, `completed_with_errors` на пути до манифеста. `skipped` также используется, когда нет файлов для ревью. | | `message` | Необязательно. Сводка для чтения человеком, например, `"No comments generated. Looks good to me."`. | | `summary` | Необязательно. Сводные показатели запуска: `files_reviewed`, `comments`, `total_tokens`, `input_tokens`, `output_tokens`, `cache_read_tokens` (omitempty), `cache_write_tokens` (omitempty), `elapsed`. Отсутствует у запусков со статусом `skipped`. | | `comments` | Присутствует всегда, но может быть пустым. Поля комментария показаны в примере выше. | diff --git a/pages/src/content/docs/zh/cli-reference.md b/pages/src/content/docs/zh/cli-reference.md index c74faff2b..03585d843 100644 --- a/pages/src/content/docs/zh/cli-reference.md +++ b/pages/src/content/docs/zh/cli-reference.md @@ -299,7 +299,7 @@ ocr review --format json | jq .summary # stdout 是单个 JSON 文档 | 字段 | 说明 | |---|---| -| `status` | `success`、`completed_with_warnings`、`completed_with_errors` 或 `skipped`。 | +| `status` | `complete`、`partial`、`failed`、`skipped`（来自运行 manifest），或 `success`、`completed_with_warnings`、`completed_with_errors`（无 manifest 的旧路径）。`skipped` 也用于没有可评审文件的情况。 | | `llm` | 实际解析的 LLM 标识。规范化后的 `model` 始终存在；`provider` 仅在使用已命名的配置 provider 时存在。 | | `message` | 可选。人类可读摘要，如 `"No comments generated. Looks good to me."`。 | | `summary` | 可选。运行聚合：`files_reviewed`、`comments`、`total_tokens`、`input_tokens`、`output_tokens`、`cache_read_tokens`（omitempty）、`cache_write_tokens`（omitempty）、`elapsed`。`skipped` 运行时省略。 | From 2f82a001f6f220ea79fab5c91dd188362a821bbe Mon Sep 17 00:00:00 2001 From: Kite <254839944+lizhengfeng101@users.noreply.github.com> Date: Mon, 28 Sep 2026 13:21:40 +0800 Subject: [PATCH 2/2] docs: Apply batched suggestions from code review Co-authored-by: Kite <254839944+lizhengfeng101@users.noreply.github.com> --- pages/src/content/docs/en/cli-reference.md | 2 +- pages/src/content/docs/ja/cli-reference.md | 2 +- pages/src/content/docs/ko/cli-reference.md | 2 +- pages/src/content/docs/ru/cli-reference.md | 2 +- pages/src/content/docs/zh/cli-reference.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/pages/src/content/docs/en/cli-reference.md b/pages/src/content/docs/en/cli-reference.md index d223ea3ac..6a489b493 100644 --- a/pages/src/content/docs/en/cli-reference.md +++ b/pages/src/content/docs/en/cli-reference.md @@ -319,7 +319,7 @@ Top-level fields: | Field | Notes | |---|---| -| `status` | `complete`, `partial`, `failed`, `skipped` (from the run manifest), or `success`, `completed_with_warnings`, `completed_with_errors` on the pre-manifest path. `skipped` also covers the no-supported-files case. | +| `status` | When the output includes a `manifest` field, its terminal state: `complete`, `partial`, `failed`, or `skipped`. Otherwise: `success`, `completed_with_warnings`, or `completed_with_errors`. `skipped` also covers the no-supported-files case. | | `llm` | Resolved LLM identity. The normalized `model` is always present; `provider` is present only for a named configured provider. | | `message` | Optional. Human-readable summary, e.g. `"No comments generated. Looks good to me."`. | | `summary` | Optional. Run aggregates: `files_reviewed`, `comments`, `total_tokens`, `input_tokens`, `output_tokens`, `cache_read_tokens` (omitempty), `cache_write_tokens` (omitempty), `elapsed`. Omitted for `skipped` runs. | diff --git a/pages/src/content/docs/ja/cli-reference.md b/pages/src/content/docs/ja/cli-reference.md index db3470a00..50c3c2d2f 100644 --- a/pages/src/content/docs/ja/cli-reference.md +++ b/pages/src/content/docs/ja/cli-reference.md @@ -300,7 +300,7 @@ ocr review --format json | jq .summary # stdout は単一の JSON ドキュメ | フィールド | 説明 | |---|---| -| `status` | `complete`、`partial`、`failed`、`skipped`（実行マニフェスト由来）、または `success`、`completed_with_warnings`、`completed_with_errors`（マニフェスト以前のパス）。`skipped` はレビュー対象ファイルがない場合にも使われます。 | +| `status` | 出力に `manifest` フィールドが含まれる場合はその終端状態（`complete`、`partial`、`failed`、`skipped`）。含まれない場合は `success`、`completed_with_warnings`、`completed_with_errors`。`skipped` はレビュー対象ファイルがない場合にも使われます。 | | `llm` | 解決された LLM の識別情報。正規化済みの `model` は常に含まれ、`provider` は名前付きの設定済み provider の場合だけ含まれます。 | | `message` | 任意。人間が読みやすいサマリー（例: `"No comments generated. Looks good to me."`）。 | | `summary` | 任意。実行の集計: `files_reviewed`、`comments`、`total_tokens`、`input_tokens`、`output_tokens`、`cache_read_tokens`（omitempty）、`cache_write_tokens`（omitempty）、`elapsed`。`skipped` の実行時は省略されます。 | diff --git a/pages/src/content/docs/ko/cli-reference.md b/pages/src/content/docs/ko/cli-reference.md index 3cd4d5c0f..b46adcf3e 100644 --- a/pages/src/content/docs/ko/cli-reference.md +++ b/pages/src/content/docs/ko/cli-reference.md @@ -313,7 +313,7 @@ ocr review --format json | jq .summary # stdout은 JSON 문서 하나입니다 | 필드 | 설명 | |---|---| -| `status` | `complete`, `partial`, `failed`, `skipped`(실행 매니페스트 기준) 또는 `success`, `completed_with_warnings`, `completed_with_errors`(매니페스트 이전 경로). `skipped`는 리뷰할 파일이 없는 경우에도 사용됩니다. | +| `status` | 출력에 `manifest` 필드가 있으면 그 터미널 상태입니다: `complete`, `partial`, `failed`, `skipped`. 없으면 `success`, `completed_with_warnings`, `completed_with_errors` 중 하나입니다. `skipped`는 리뷰할 파일이 없는 경우에도 사용됩니다. | | `llm` | 해석된 LLM 정보입니다. 정규화한 `model`은 항상 있고, `provider`는 이름이 있는 설정된 프로바이더일 때만 나옵니다. | | `message` | 선택. 사람이 읽는 요약입니다(예: `"No comments generated. Looks good to me."`). | | `summary` | 선택. 실행 집계입니다: `files_reviewed`, `comments`, `total_tokens`, `input_tokens`, `output_tokens`, `cache_read_tokens`(omitempty), `cache_write_tokens`(omitempty), `elapsed`. `skipped` 실행에서는 나오지 않습니다. | diff --git a/pages/src/content/docs/ru/cli-reference.md b/pages/src/content/docs/ru/cli-reference.md index 68de7fafd..e28d3eee0 100644 --- a/pages/src/content/docs/ru/cli-reference.md +++ b/pages/src/content/docs/ru/cli-reference.md @@ -304,7 +304,7 @@ ocr review --format json | jq .summary # stdout — единый JSON-доку | Поле | Примечания | |---|---| -| `status` | `complete`, `partial`, `failed`, `skipped` (из манифеста запуска) или `success`, `completed_with_warnings`, `completed_with_errors` на пути до манифеста. `skipped` также используется, когда нет файлов для ревью. | +| `status` | Если в выводе есть поле `manifest` — его терминальное состояние: `complete`, `partial`, `failed` или `skipped`. Иначе: `success`, `completed_with_warnings` или `completed_with_errors`. `skipped` также используется, когда нет файлов для ревью. | | `message` | Необязательно. Сводка для чтения человеком, например, `"No comments generated. Looks good to me."`. | | `summary` | Необязательно. Сводные показатели запуска: `files_reviewed`, `comments`, `total_tokens`, `input_tokens`, `output_tokens`, `cache_read_tokens` (omitempty), `cache_write_tokens` (omitempty), `elapsed`. Отсутствует у запусков со статусом `skipped`. | | `comments` | Присутствует всегда, но может быть пустым. Поля комментария показаны в примере выше. | diff --git a/pages/src/content/docs/zh/cli-reference.md b/pages/src/content/docs/zh/cli-reference.md index 03585d843..f577bf5c7 100644 --- a/pages/src/content/docs/zh/cli-reference.md +++ b/pages/src/content/docs/zh/cli-reference.md @@ -299,7 +299,7 @@ ocr review --format json | jq .summary # stdout 是单个 JSON 文档 | 字段 | 说明 | |---|---| -| `status` | `complete`、`partial`、`failed`、`skipped`（来自运行 manifest），或 `success`、`completed_with_warnings`、`completed_with_errors`（无 manifest 的旧路径）。`skipped` 也用于没有可评审文件的情况。 | +| `status` | 输出包含 `manifest` 字段时，为 manifest 的终态：`complete`、`partial`、`failed`、`skipped`；否则为 `success`、`completed_with_warnings`、`completed_with_errors`。`skipped` 也用于没有可评审文件的情况。 | | `llm` | 实际解析的 LLM 标识。规范化后的 `model` 始终存在；`provider` 仅在使用已命名的配置 provider 时存在。 | | `message` | 可选。人类可读摘要，如 `"No comments generated. Looks good to me."`。 | | `summary` | 可选。运行聚合：`files_reviewed`、`comments`、`total_tokens`、`input_tokens`、`output_tokens`、`cache_read_tokens`（omitempty）、`cache_write_tokens`（omitempty）、`elapsed`。`skipped` 运行时省略。 |