Skip to content

docs(cli-reference): document missing review flags - #900

Merged
lizhengfeng101 merged 2 commits into
alibaba:mainfrom
guiyangyuan:docs/sync-review-flags
Aug 15, 2026
Merged

lizhengfeng101 merged 2 commits into
alibaba:mainfrom
guiyangyuan:docs/sync-review-flags

Conversation

@guiyangyuan

Copy link
Copy Markdown
Contributor

Description

Synchronize the ocr review CLI reference with the flags registered by the command implementation.

  • document --background-file, --exclude, and --max-tokens-budget in the English, Chinese, Japanese, and Russian review flag tables
  • add the existing --provider flag to the Russian table, bringing it in line with the other locales
  • keep the descriptions aligned with the command help and runtime behavior

These flags were available in the CLI but absent from the review reference tables, making them difficult to discover from the official documentation. This is documentation-only and does not change runtime behavior.

--no-filter is intentionally out of scope because it is already tracked separately in #867.

Type of Change

  • Bug fix (non-breaking change that fixes an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Refactoring (no functional changes)
  • Documentation update
  • CI / Build / Tooling

How Has This Been Tested?

  • make test passes locally
  • Manual testing (describe below)

Validation performed:

  • cd pages && npm run typecheck
  • cd pages && npm run build
  • git diff --check
  • repository-required ocr review --audience agent --background ... self-review command (Markdown files are excluded from OCR's selectable code files, so it completed with no review items)

Checklist

  • My code follows the project's coding style (go fmt, go vet)
  • I have performed a self-review of my code
  • I have added tests that prove my fix is effective or my feature works (not applicable: documentation-only)
  • New and existing unit tests pass locally with my changes (not run: no runtime changes)
  • I have updated the documentation accordingly (if applicable)
  • I have signed the CLA

Related Issues

None.

@CLAassistant

CLAassistant commented Aug 14, 2026 •

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@github-actions

Copy link
Copy Markdown
Contributor

✅ OpenCodeReview: Review skipped: no items were selected.

@guiyangyuan
guiyangyuan marked this pull request as ready for review August 14, 2026 06:02

@lizhengfeng101 lizhengfeng101 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

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.

4 participants