docs(pages): update i18n docs for unified Provider system
Some checks are pending
CI / test (push) Waiting to run
Deploy Pages / build (push) Waiting to run
Deploy Pages / deploy (push) Blocked by required conditions

Update documentation strings across en/ja/zh to reflect the new
provider-based configuration: add full scan review mode, list built-in
providers (Anthropic, OpenAI, DashScope, DeepSeek, Z.AI), and replace
legacy config keys with provider-scoped keys including extraHeaders.
This commit is contained in:
kite 2026-07-01 19:56:24 +08:00
parent 0dac8ac376
commit 44fabbaa68
3 changed files with 48 additions and 36 deletions

View file

@ -110,8 +110,8 @@ export const en: TranslationKeys = {
'docs.overviewTitle': 'Overview',
'docs.overviewDesc': '(short <code>ocr</code>) is an AI-powered code review CLI tool.',
'docs.overviewFeatures': 'Core Features:',
'docs.overviewFeat1': 'Supports workspace changes, branch diff, and single-commit review modes',
'docs.overviewFeat2': 'Supports LLM services with Anthropic and OpenAI-compatible protocols',
'docs.overviewFeat1': 'Supports workspace, branch diff, single-commit, and full scan review modes',
'docs.overviewFeat2': 'Built-in Anthropic, OpenAI, DashScope, DeepSeek, Z.AI and custom provider support',
'docs.overviewFeat3': 'Concurrent review with customizable timeouts',
'docs.overviewFeat4': 'Output format supports text and json',
'docs.overviewFeat5': 'Zero config for Claude Code users',
@ -120,22 +120,26 @@ export const en: TranslationKeys = {
'docs.installLabel': 'Install',
'docs.installVerifyLabel': 'Verify Installation',
'docs.configTitle': 'Configuration & Verification',
'docs.configDesc': 'Manage CLI configuration settings, stored in <code>~/.opencodereview/config.json</code>.',
'docs.configDesc': 'Manage CLI configuration through a unified Provider system. Ships with built-in providers and supports custom providers for private deployments. Config is stored in <code>~/.opencodereview/config.json</code>.',
'docs.configInteractive': 'Interactive Setup (Recommended)',
'docs.configInteractiveDesc': 'The easiest way to configure Open Code Review. Select from built-in providers or add a custom one.',
'docs.configInteractiveDesc': 'The easiest way to configure Open Code Review. Select from built-in providers or add a custom one, set your API key, and choose a model.',
'docs.configModelSelect': 'Model Selection',
'docs.configModelSelectDesc': 'After choosing a provider, pick the model to use.',
'docs.configListProviders': 'List Built-in Providers',
'docs.configListProvidersDesc': 'View all available built-in LLM providers.',
'docs.configManual': 'Manual Configuration',
'docs.configCommand': 'Command',
'docs.configExample': 'Example',
'docs.configManualBuiltin': 'Using a Built-in Provider',
'docs.configManualBuiltinDesc': 'Built-in providers come with preset API URLs and protocols — just supply an API key.',
'docs.configManualCustom': 'Using a Custom Provider',
'docs.configManualCustomDesc': 'Connect to private deployments or other compatible endpoints.',
'docs.configManualCustomNote': 'url and protocol are required for custom providers. Supported protocols: anthropic, openai.',
'docs.configKeys': 'Supported Config Keys',
'docs.configKeyUrl': 'API URL',
'docs.configKeyToken': 'API Key',
'docs.configKeyModel': 'Model Name',
'docs.configKeyAnthropic': 'Use Anthropic SDK',
'docs.configKeyExtraBody': 'Vendor-specific request body fields (JSON)',
'docs.configKeyProvider': 'Active provider name',
'docs.configKeyProviderApiKey': 'API key for the provider',
'docs.configKeyProviderModel': 'Model name',
'docs.configKeyProviderUrl': 'API URL override',
'docs.configKeyProviderExtraBody': 'Custom request body fields (JSON)',
'docs.configKeyProviderExtraHeaders': 'Custom HTTP headers (key=value)',
'docs.configKeyLanguage': 'Output Language',
'docs.configKeyTelemetry': 'Telemetry',
'docs.configVerify': 'Verify Configuration',

View file

@ -112,8 +112,8 @@ export const ja: TranslationKeys = {
'docs.overviewTitle': '概要',
'docs.overviewDesc': '(略称 <code>ocr</code>)は AI 駆動のコードレビュー CLI ツールです。',
'docs.overviewFeatures': 'コア機能:',
'docs.overviewFeat1': 'ワークスペース変更、ブランチ差分、単一コミットレビューモードをサポート',
'docs.overviewFeat2': 'Anthropic および OpenAI 互換プロトコルの LLM サービスをサポート',
'docs.overviewFeat1': 'ワークスペース変更、ブランチ差分、単一コミット、フルスキャンレビューモードをサポート',
'docs.overviewFeat2': 'Anthropic、OpenAI、DashScope、DeepSeek、Z.AI などの内蔵プロバイダーとカスタムプロバイダーをサポート',
'docs.overviewFeat3': 'カスタマイズ可能なタイムアウト付き並行レビュー',
'docs.overviewFeat4': '出力形式は text と json をサポート',
'docs.overviewFeat5': 'Claude Code ユーザーはゼロ設定',
@ -122,22 +122,26 @@ export const ja: TranslationKeys = {
'docs.installLabel': 'インストール',
'docs.installVerifyLabel': 'インストール確認',
'docs.configTitle': '設定と検証',
'docs.configDesc': 'CLI 設定を管理します。<code>~/.opencodereview/config.json</code> に保存されます。',
'docs.configDesc': '統一されたプロバイダーシステムで CLI 設定を管理します。多数の内蔵プロバイダーを搭載し、プライベートデプロイメント向けのカスタムプロバイダーもサポート。設定は <code>~/.opencodereview/config.json</code> に保存されます。',
'docs.configInteractive': '対話式セットアップ(推奨)',
'docs.configInteractiveDesc': '最も簡単な設定方法。内蔵プロバイダーから選択するかカスタムプロバイダーを追加します。',
'docs.configInteractiveDesc': '最も簡単な設定方法。内蔵プロバイダーから選択するかカスタムプロバイダーを追加し、API キーを設定してモデルを選びます。',
'docs.configModelSelect': 'モデル選択',
'docs.configModelSelectDesc': 'プロバイダーを選択した後、使用するモデルを選びます。',
'docs.configListProviders': '内蔵プロバイダー一覧',
'docs.configListProvidersDesc': '利用可能なすべての内蔵 LLM プロバイダーを表示します。',
'docs.configManual': '手動設定',
'docs.configCommand': 'コマンド',
'docs.configExample': '例',
'docs.configManualBuiltin': '内蔵プロバイダーを使用',
'docs.configManualBuiltinDesc': '内蔵プロバイダーには API URL とプロトコルがプリセットされています。API キーを提供するだけで始められます。',
'docs.configManualCustom': 'カスタムプロバイダーを使用',
'docs.configManualCustomDesc': 'プライベートデプロイメントや他の互換エンドポイントに接続します。',
'docs.configManualCustomNote': 'カスタムプロバイダーには url と protocol が必須です。サポートされるプロトコルanthropic、openai。',
'docs.configKeys': 'サポートされる設定キー',
'docs.configKeyUrl': 'API アドレス',
'docs.configKeyToken': 'API キー',
'docs.configKeyModel': 'モデル名',
'docs.configKeyAnthropic': 'Anthropic SDK を使用',
'docs.configKeyExtraBody': 'ベンダー固有のリクエストボディフィールド (JSON)',
'docs.configKeyProvider': 'アクティブなプロバイダー名',
'docs.configKeyProviderApiKey': 'プロバイダーの API キー',
'docs.configKeyProviderModel': 'モデル名',
'docs.configKeyProviderUrl': 'API URL オーバーライド',
'docs.configKeyProviderExtraBody': 'カスタムリクエストボディフィールド (JSON)',
'docs.configKeyProviderExtraHeaders': 'カスタム HTTP ヘッダー (key=value)',
'docs.configKeyLanguage': '出力言語',
'docs.configKeyTelemetry': 'テレメトリ',
'docs.configVerify': '設定確認',

View file

@ -112,8 +112,8 @@ export const zh: TranslationKeys = {
'docs.overviewTitle': '概览',
'docs.overviewDesc': '(简称 <code>ocr</code>)是一款 AI 驱动的代码审查 CLI 工具。',
'docs.overviewFeatures': '核心功能:',
'docs.overviewFeat1': '支持工作区变更、分支差异和单次提交审查模式',
'docs.overviewFeat2': '支持 Anthropic 和 OpenAI 兼容协议的 LLM 服务',
'docs.overviewFeat1': '支持工作区变更、分支差异、单次提交和全量扫描审查模式',
'docs.overviewFeat2': '内置 Anthropic、OpenAI、DashScope、DeepSeek、Z.AI 等主流供应商及自定义供应商支持',
'docs.overviewFeat3': '并发审查与可自定义超时',
'docs.overviewFeat4': '输出格式支持 text 和 json',
'docs.overviewFeat5': 'Claude Code 用户零配置',
@ -122,22 +122,26 @@ export const zh: TranslationKeys = {
'docs.installLabel': '安装',
'docs.installVerifyLabel': '验证安装',
'docs.configTitle': '配置与验证',
'docs.configDesc': '管理 CLI 配置,存储在 <code>~/.opencodereview/config.json</code>。',
'docs.configDesc': '通过统一的 Provider 体系管理 CLI 配置。内置多个主流供应商,同时支持自定义供应商用于私有化部署。配置存储在 <code>~/.opencodereview/config.json</code>。',
'docs.configInteractive': '交互式设置(推荐)',
'docs.configInteractiveDesc': '最简单的配置方式。从内置提供商中选择或添加自定义提供商。',
'docs.configInteractiveDesc': '最简单的配置方式。从内置供应商中选择或添加自定义供应商,设置 API 密钥,选择模型。',
'docs.configModelSelect': '模型选择',
'docs.configModelSelectDesc': '选择供商后,选择要使用的模型。',
'docs.configListProviders': '列出内置供商',
'docs.configListProvidersDesc': '查看所有可用的内置 LLM 供商。',
'docs.configModelSelectDesc': '选择商后,选择要使用的模型。',
'docs.configListProviders': '列出内置商',
'docs.configListProvidersDesc': '查看所有可用的内置 LLM 商。',
'docs.configManual': '手动配置',
'docs.configCommand': '命令',
'docs.configExample': '示例',
'docs.configManualBuiltin': '使用内置供应商',
'docs.configManualBuiltinDesc': '内置供应商已预设 API 地址和协议,只需提供 API 密钥即可开始。',
'docs.configManualCustom': '使用自定义供应商',
'docs.configManualCustomDesc': '连接到私有化部署或其他兼容端点。',
'docs.configManualCustomNote': '自定义供应商必须提供 url 和 protocol。支持的协议anthropic、openai。',
'docs.configKeys': '支持的配置键',
'docs.configKeyUrl': 'API 地址',
'docs.configKeyToken': 'API 密钥',
'docs.configKeyModel': '模型名称',
'docs.configKeyAnthropic': '使用 Anthropic SDK',
'docs.configKeyExtraBody': '提供商特定的请求体字段 (JSON)',
'docs.configKeyProvider': '当前活跃供应商名称',
'docs.configKeyProviderApiKey': '供应商的 API 密钥',
'docs.configKeyProviderModel': '模型名称',
'docs.configKeyProviderUrl': 'API 地址覆盖',
'docs.configKeyProviderExtraBody': '自定义请求体字段 (JSON)',
'docs.configKeyProviderExtraHeaders': '自定义 HTTP 头 (key=value)',
'docs.configKeyLanguage': '输出语言',
'docs.configKeyTelemetry': '遥测',
'docs.configVerify': '验证配置',