Skip to content

docs: 强化 README 英文版入口 - #35

Merged
zkwi merged 2 commits into
mainfrom
codex/security-0.12.1
Aug 10, 2026
Merged

docs: 强化 README 英文版入口#35
zkwi merged 2 commits into
mainfrom
codex/security-0.12.1

Conversation

@zkwi

@zkwi zkwi commented Aug 10, 2026

Copy link
Copy Markdown
Owner

Summary

  • 强化中文 README 首屏的中英对照内容。
  • 增加醒目的英文文档提示框,并将英文 README 放在快捷入口首位。
  • 补充英文项目定位和工作流摘要。

User Problem and Scope

  • User problem: 默认 GitHub 首页中的英文版入口不够醒目,国际用户不易快速发现完整英文文档。
  • Files/modules changed: README.md
  • Explicitly out of scope: 产品代码、配置、界面截图、依赖、版本号、标签与 Release。

Impact Check

  • I read CONTRIBUTING.md, ARCHITECTURE.md, and SECURITY.md; ASR quality/latency guardrails are not applicable to this documentation-only change.
  • No impact on ASR, final-result gating, optional LLM editing, clipboard/paste, or successful statistics.
  • No impact on config/defaults, privacy, logging, local history, hotkeys, tray, updater, installer, or screenshots.
  • This changes only the language-navigation presentation of the Chinese README; no product behavior or English README content requires synchronization.
  • No real keys, transcripts, hotwords, prompts, OCR/context bodies, raw logs, statistics files, or Windows username paths are included.

Checks

  • npm run scan:secrets:staged (pre-commit hook)
  • npm run ai:check
  • npm run audit:npm — skipped; no dependency changes
  • npm run audit:rust — skipped; no dependency changes
  • npm run ai:release-check — skipped; not release-facing
  • Manual UI verification — not applicable; no application UI changed

Risk Areas

Documentation discoverability only. No runtime, security-boundary, privacy, installer, or release risk.

Evidence and Notes

npm run ai:check passed with 61 frontend tests and 248 Rust tests, plus frontend build, Rust checks, formatting, governance, release-preflight self-test, and secret scans.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 12e3e91283

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md Outdated
@zkwi
zkwi merged commit d59f2f5 into main Aug 10, 2026
10 checks passed
@zkwi
zkwi deleted the codex/security-0.12.1 branch August 10, 2026 06:15
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.

1 participant