docs: make README default English with localized variants by BlackishGreen33 · Pull Request #24 · BlackishGreen33/Confession

BlackishGreen33 · 2026-03-10T16:20:55Z

Summary\n- make README.md the default English documentation\n- add README.zh-TW.md and README.zh-CN.md with localized quick-start/docs pointers\n- sync steering + AGENTS language policy to reflect English-default README\n\n## Validation\n- pnpm lint\n- pnpm build

Copilot

Pull request overview

Makes the repository’s primary README English by default, adds localized README variants, and updates steering/agent guidance to match the new documentation language policy.

Changes:

Rewrite README.md as the English-default main documentation with updated sections (routes, exports, commands, etc.).
Add localized entry-point docs: README.zh-TW.md and README.zh-CN.md.
Update AGENTS.md and .kiro/steering/* language-policy references to reflect the English-default README.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
README.md	Switches main README to English and refreshes feature/config/API documentation.
README.zh-TW.md	Adds Traditional Chinese localized pointers + quick-start.
README.zh-CN.md	Adds Simplified Chinese localized pointers + quick-start.
AGENTS.md	Updates agent language policy to note English-default README plus localized variants.
.kiro/steering/structure.md	Adds localized README files to documented repo structure.
.kiro/steering/product.md	Updates language preference policy to reflect English-default README.
.kiro/steering/language-preferences.md	Updates language-preference guidance to reflect English-default README.

Comments suppressed due to low confidence (1)

.kiro/steering/language-preferences.md:12

「前端預設語言為繁體中文（zh-TW）」這句與目前實作的預設設定不一致：預設 ui.language 是 auto（會依宿主語言解析，英文環境通常為 en），只有在缺值/不可判定時才回退 zh-TW。建議改成「預設為 auto，不可判定時回退 zh-TW」以避免後續指引與程式碼衝突。

- `README.md` 以英文為預設主版，並同步維護 `README.zh-TW.md`、`README.zh-CN.md`
- 前端 Webview 支援 `zh-TW` / `zh-CN` / `en` 三語
- 前端預設語言為繁體中文（`zh-TW`）；當 `ui.language = auto` 時需跟隨宿主語言（VS Code / 瀏覽器）

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-10T16:26:49Z

+|------|------|------|
+| `confession.api.baseUrl` | `http://localhost:3000` | API server base URL |
+| `confession.api.mode` | `local` | Connection mode (`local` / `remote`) |
+| `confession.llm.apiKey` | — | Gemini API key |


confession.llm.apiKey is not Gemini-specific; in the extension settings it is documented/implemented as the API key for the selected provider (confession.llm.provider). Update this description to be provider-agnostic (or mention it depends on the selected provider) to avoid misleading users.

Suggested change

| `confession.llm.apiKey` | — | Gemini API key |

| `confession.llm.apiKey` | — | LLM provider API key (depends on `confession.llm.provider`) |

Copilot · 2026-03-10T16:26:50Z

+- Node.js >= 18
 - pnpm 9.x
- Go 1.21+（僅編譯 WASM 時需要）
+- Go 1.21+ (only needed when building WASM analyzer)


The Go prerequisite version here (Go 1.21+) does not match the repository’s current go-analyzer/go.mod which declares go 1.25.5. Please align the README prerequisite with the actual minimum Go version required (or adjust go.mod if that version is unintended).

Suggested change

- Go 1.21+ (only needed when building WASM analyzer)

- Go 1.25.5+ (only needed when building WASM analyzer)

Copilot · 2026-03-10T16:26:50Z

@@ -34,6 +34,7 @@
 - 定位：VS Code 靜態程式碼漏洞分析插件
 - 介面目標環境：VS Code Webview（桌面場景優先）
 - Webview UI 語言：支援 `zh-TW` / `zh-CN` / `en`，預設 `zh-TW`，`auto` 需跟隨宿主語言


Webview UI 語言…預設 zh-TW doesn’t match the actual default config (ui.language defaults to auto in both extension settings and backend DEFAULT_CONFIG). With auto, the resolved locale follows the host language tag (and may be en on English hosts); only the fallback when missing/undecidable is zh-TW. Consider rewording to “預設設定為 auto；不可判定時回退 zh-TW”。

Suggested change

- Webview UI 語言：支援 `zh-TW` / `zh-CN` / `en`，預設 `zh-TW`，`auto` 需跟隨宿主語言

- Webview UI 語言：支援 `zh-TW` / `zh-CN` / `en`，預設設定為 `auto`，依宿主語言解析；不可判定時回退 `zh-TW`

Copilot · 2026-03-10T16:26:50Z

- 對話、程式碼註釋、文件一律使用繁體中文
+- 對話與程式碼註釋使用繁體中文
+- `README.md` 預設使用英文，並維護 `README.zh-TW.md`、`README.zh-CN.md` 作為對照文件
 - Webview UI 支援 `zh-TW` / `zh-CN` / `en`，預設 `zh-TW`


「Webview UI…預設 zh-TW」與實際預設設定不一致：目前預設為 ui.language = auto（extension 與後端 DEFAULT_CONFIG 皆為 auto），auto 會依宿主語言解析（英文環境會是 en），只有在缺值/不可判定時才回退 zh-TW。建議將此行改為描述 auto 為預設並補充 fallback 行為。

Suggested change

- Webview UI 支援 `zh-TW` / `zh-CN` / `en`，預設 `zh-TW`

- Webview UI 支援 `zh-TW` / `zh-CN` / `en`，預設 `auto`（依宿主語言解析，無法判定時回退 `zh-TW`）

Copilot · 2026-03-10T16:26:50Z

+- Product default locale: `zh-TW`
+- Config key: `confession.ui.language = auto | zh-TW | zh-CN | en`
+- `auto` continuously follows host locale (VS Code / browser), not one-time detection.


Product default locale: zh-TW is inconsistent with the actual default config (ui.language defaults to auto in both the extension settings and backend DEFAULT_CONFIG). With auto, the resolved UI locale follows the host language tag and will often be en on English hosts; only the fallback/default when undecidable is zh-TW. Update this bullet (and/or add a separate fallback note) to reflect: default setting is auto, resolved locale follows host, fallback is zh-TW when missing/undecidable.

Suggested change

- Product default locale: `zh-TW`

- Config key: `confession.ui.language = auto | zh-TW | zh-CN | en`

- `auto` continuously follows host locale (VS Code / browser), not one-time detection.

- Default setting: `confession.ui.language = auto`

- Resolved UI locale: follows host language tag (VS Code / browser) when set to `auto`

- Fallback locale when host locale is missing/undecidable: `zh-TW`

- Config key: `confession.ui.language = auto | zh-TW | zh-CN | en`

Copilot · 2026-03-10T16:26:51Z

+- 產品預設顯示語系：`zh-TW`
+- 設定鍵：`confession.ui.language = auto | zh-TW | zh-CN | en`
+- `auto` 為持續跟隨模式（依 VS Code / 瀏覽器語言）


「產品預設顯示語系：zh-TW」這句與實際預設設定不一致：目前 ui.language 預設是 auto（extension 設定與後端 DEFAULT_CONFIG 皆如此），auto 會依宿主語言解析，英文環境通常會顯示 en；只有在缺值/不可判定時才會回退 zh-TW。建議把此行改成「預設設定為 auto，不可判定時回退 zh-TW」或分成兩行說明。

Suggested change

- 產品預設顯示語系：`zh-TW`

- 設定鍵：`confession.ui.language = auto | zh-TW | zh-CN | en`

- `auto` 為持續跟隨模式（依 VS Code / 瀏覽器語言）

- 產品預設顯示語系設定：`auto`

- 設定鍵：`confession.ui.language = auto | zh-TW | zh-CN | en`

- `auto` 為持續跟隨模式（依 VS Code / 瀏覽器語言），無法判定時回退 `zh-TW`

Copilot · 2026-03-10T16:26:51Z

+- 支持语言：`zh-TW`、`zh-CN`、`en`
+- 产品默认显示语言：`zh-TW`
+- 配置键：`confession.ui.language = auto | zh-TW | zh-CN | en`
+- `auto` 为持续跟随模式（根据 VS Code / 浏览器语言）
+- 导出内容本地化：`CSV` / `Markdown` / `PDF`
+- 机器可读导出保持稳定：`JSON` / `SARIF` 不翻译键名


「产品默认显示语言：zh-TW」与实际默认配置不一致：目前 ui.language 默认是 auto（extension 配置与后端 DEFAULT_CONFIG 都是如此），auto 会按宿主语言解析，英文环境通常会显示 en；只有在缺值/无法判定时才回退 zh-TW。建议把该行改为「默认配置为 auto，无法判定时回退 zh-TW」或拆成两行说明。

BlackishGreen33 added 2 commits March 11, 2026 00:20

📝 docs(readme): set english default with i18n docs

7a86104

📝 docs(steering): sync readme language policy

b3d52a2

Copilot AI review requested due to automatic review settings March 10, 2026 16:20

Copilot started reviewing on behalf of BlackishGreen33 March 10, 2026 16:21 View session

BlackishGreen33 merged commit a9d57b1 into main Mar 10, 2026
9 checks passed

BlackishGreen33 deleted the codex/readme-i18n-default-english branch March 10, 2026 16:22

Copilot AI reviewed Mar 10, 2026

View reviewed changes

Navigation Menu

docs: make README default English with localized variants - #24

docs: make README default English with localized variants#24
BlackishGreen33 merged 2 commits into
mainfrom
codex/readme-i18n-default-english

BlackishGreen33 commented Mar 10, 2026

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 10, 2026

Uh oh!

Copilot AI Mar 10, 2026

Uh oh!

Copilot AI Mar 10, 2026

Uh oh!

Copilot AI Mar 10, 2026

Uh oh!

Copilot AI Mar 10, 2026

Uh oh!

Copilot AI Mar 10, 2026

Uh oh!

Copilot AI Mar 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	\| `confession.llm.apiKey` \| — \| Gemini API key \|
	\| `confession.llm.apiKey` \| — \| LLM provider API key (depends on `confession.llm.provider`) \|

	- Go 1.21+ (only needed when building WASM analyzer)
	- Go 1.25.5+ (only needed when building WASM analyzer)

	- Webview UI 語言：支援 `zh-TW` / `zh-CN` / `en`，預設 `zh-TW`，`auto` 需跟隨宿主語言
	- Webview UI 語言：支援 `zh-TW` / `zh-CN` / `en`，預設設定為 `auto`，依宿主語言解析；不可判定時回退 `zh-TW`

	- Webview UI 支援 `zh-TW` / `zh-CN` / `en`，預設 `zh-TW`
	- Webview UI 支援 `zh-TW` / `zh-CN` / `en`，預設 `auto`（依宿主語言解析，無法判定時回退 `zh-TW`）

Conversation

BlackishGreen33 commented Mar 10, 2026

Summary\n- make README.md the default English documentation\n- add README.zh-TW.md and README.zh-CN.md with localized quick-start/docs pointers\n- sync steering + AGENTS language policy to reflect English-default README\n\n## Validation\n- pnpm lint\n- pnpm build

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 10, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants