From bddac10c1fb85337f136e3327c850492e85608f1 Mon Sep 17 00:00:00 2001 From: Zhibo Lin <147509942+LE0-Lin@users.noreply.github.com> Date: Thu, 8 Oct 2026 17:18:22 +0800 Subject: [PATCH] docs: name Chinese variants simplified and traditional --- CHANGELOG.md | 4 +++ README.md | 2 +- README.zh-CN.md => README.simplified.md | 8 +++--- README.zh-TW.md => README.traditional.md | 8 +++--- docs/README.md | 2 +- docs/limitations.md | 2 +- docs/release-readiness.md | 4 +-- docs/{zh-CN => simplified}/limitations.md | 2 +- docs/{zh-CN => simplified}/user-guide.md | 2 +- docs/{zh-TW => traditional}/limitations.md | 2 +- docs/{zh-TW => traditional}/user-guide.md | 2 +- docs/translations.md | 10 ++++--- docs/user-guide.md | 2 +- tests/test_documentation_languages.py | 33 ++++++++++++---------- 14 files changed, 46 insertions(+), 37 deletions(-) rename README.zh-CN.md => README.simplified.md (92%) rename README.zh-TW.md => README.traditional.md (92%) rename docs/{zh-CN => simplified}/limitations.md (98%) rename docs/{zh-CN => simplified}/user-guide.md (97%) rename docs/{zh-TW => traditional}/limitations.md (97%) rename docs/{zh-TW => traditional}/user-guide.md (97%) diff --git a/CHANGELOG.md b/CHANGELOG.md index ca8e4aa..84a3636 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,10 @@ - Optional Simplified/Traditional Chinese repository overviews, core user guides and limitation summaries, with reciprocal language links and an explicit source-revision/coverage note. Advanced references remain English; CLI messages, JSON fields, rule semantics and the published v0.23.0 distributions are unchanged. +### Changed + +- Name Chinese documentation paths by script (`simplified` and `traditional`) rather than region, updating all language selectors and internal links. Runtime behavior and published v0.23.0 artifacts are unchanged. + ## v0.23.0 The English core workflow is packaged as a local deterministic linter and CI diff --git a/README.md b/README.md index 2de590c..ea01a6a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # AgentConfigScore -English | [简体中文](https://github.com/LE0-Lin/AgentConfigScore/blob/main/README.zh-CN.md) | [繁體中文](https://github.com/LE0-Lin/AgentConfigScore/blob/main/README.zh-TW.md) +English | [简体中文](https://github.com/LE0-Lin/AgentConfigScore/blob/main/README.simplified.md) | [繁體中文](https://github.com/LE0-Lin/AgentConfigScore/blob/main/README.traditional.md)

AgentConfigScore A 100 diff --git a/README.zh-CN.md b/README.simplified.md similarity index 92% rename from README.zh-CN.md rename to README.simplified.md index 0dd9e42..b8b4a12 100644 --- a/README.zh-CN.md +++ b/README.simplified.md @@ -1,6 +1,6 @@ # AgentConfigScore -[English](README.md) | 简体中文 | [繁體中文](README.zh-TW.md) +[English](README.md) | 简体中文 | [繁體中文](README.traditional.md) 为 AI 编程助手的指令文件提供本地检查与 PR 回归门禁。 @@ -26,8 +26,8 @@ agent-config-score diff `acs` 是短命令别名。v0.23.0+ 还可以使用 `python -m agent_config_score`，避免终端 PATH 没有找到命令的问题。 -- [简体中文使用指南](docs/zh-CN/user-guide.md)：安装、基线、报告、退出码与排错。 -- [分数含义与限制](docs/zh-CN/limitations.md)：先了解什么能检出、什么仍可能漏掉。 +- [简体中文使用指南](docs/simplified/user-guide.md)：安装、基线、报告、退出码与排错。 +- [分数含义与限制](docs/simplified/limitations.md)：先了解什么能检出、什么仍可能漏掉。 - [完整英文文档索引](docs/README.md)：进阶接口与研究资料。 ## 为什么采用回归检查 @@ -105,7 +105,7 @@ jobs: 运行时没有第三方依赖；本地扫描不调用 AI API，也不执行指令文件中的命令。包安装需要访问所选软件包索引；GitHub Actions 是单独的 CI 环境，报告访问权限由你的工作流控制。 -跨平台测试、维护的规则用例和安装验收证明程序符合指定的工程预期，**不证明它比直接问 AI 更准，也不证明它已经有真实用户价值**。独立对照评测尚未完成，已知语义漏报仍保留。详见[限制说明](docs/zh-CN/limitations.md)与[评测资料（英文）](benchmarks/README.md)。 +跨平台测试、维护的规则用例和安装验收证明程序符合指定的工程预期，**不证明它比直接问 AI 更准，也不证明它已经有真实用户价值**。独立对照评测尚未完成，已知语义漏报仍保留。详见[限制说明](docs/simplified/limitations.md)与[评测资料（英文）](benchmarks/README.md)。 本页是核心入门的中文概览，不是完整英文 README 的逐行翻译。使用指南和限制说明已提供中文；高级 Action 参数、规则语法细节、贡献及研究文档目前仍为英文。[翻译范围与维护说明](docs/translations.md)。命令、终端消息和 JSON 协议保持原样，English 仍是默认入口。 diff --git a/README.zh-TW.md b/README.traditional.md similarity index 92% rename from README.zh-TW.md rename to README.traditional.md index 98c6560..17e30fa 100644 --- a/README.zh-TW.md +++ b/README.traditional.md @@ -1,6 +1,6 @@ # AgentConfigScore -[English](README.md) | [简体中文](README.zh-CN.md) | 繁體中文 +[English](README.md) | [简体中文](README.simplified.md) | 繁體中文 為 AI 程式開發助手的指令檔提供本機檢查與 PR 回歸檢查。 @@ -26,8 +26,8 @@ agent-config-score diff `acs` 是較短的命令別名。v0.23.0+ 也能使用 `python -m agent_config_score`，不必依賴終端機 PATH 找到主命令。 -- [繁體中文使用指南](docs/zh-TW/user-guide.md)：安裝、基準、報告、結束代碼與疑難排解。 -- [分數意義與限制](docs/zh-TW/limitations.md)：先了解能偵測哪些問題，以及可能遺漏什麼。 +- [繁體中文使用指南](docs/traditional/user-guide.md)：安裝、基準、報告、結束代碼與疑難排解。 +- [分數意義與限制](docs/traditional/limitations.md)：先了解能偵測哪些問題，以及可能遺漏什麼。 - [完整英文文件索引](docs/README.md)：進階介面與研究資料。 ## 為什麼使用回歸檢查 @@ -105,7 +105,7 @@ jobs: 執行時沒有第三方相依套件；本機掃描不呼叫 AI API，也不執行指令檔內的命令。安裝套件需存取選定的套件索引；GitHub Actions 是獨立的 CI 環境，報告存取權限由你的工作流程決定。 -跨平台測試、持續維護的規則案例與安裝驗收，證明程式符合指定的工程預期，**不代表它比直接詢問 AI 更準確，也不代表已經具備真實使用者價值**。獨立對照評測尚未完成，已知的語意漏報仍保留。請見[限制說明](docs/zh-TW/limitations.md)與[評測資料（英文）](benchmarks/README.md)。 +跨平台測試、持續維護的規則案例與安裝驗收，證明程式符合指定的工程預期，**不代表它比直接詢問 AI 更準確，也不代表已經具備真實使用者價值**。獨立對照評測尚未完成，已知的語意漏報仍保留。請見[限制說明](docs/traditional/limitations.md)與[評測資料（英文）](benchmarks/README.md)。 本頁是核心入門的中文概覽，不是完整英文 README 的逐行翻譯。使用指南與限制說明已提供中文；進階 Action 參數、規則語法細節、貢獻和研究文件目前仍為英文。[翻譯範圍與維護說明](docs/translations.md)。命令、終端機訊息和 JSON 協定維持原樣，English 仍為預設入口。 diff --git a/docs/README.md b/docs/README.md index 391ac32..867ed99 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,6 +1,6 @@ # Documentation -[English](user-guide.md) | [简体中文](zh-CN/user-guide.md) | [繁體中文](zh-TW/user-guide.md) +[English](user-guide.md) | [简体中文](simplified/user-guide.md) | [繁體中文](traditional/user-guide.md) Start with the [user guide](user-guide.md): install, initialize, check a change, read the result, and troubleshoot a failing gate. diff --git a/docs/limitations.md b/docs/limitations.md index 4c45744..236195d 100644 --- a/docs/limitations.md +++ b/docs/limitations.md @@ -1,6 +1,6 @@ # What the score does—and does not—mean -English | [简体中文](zh-CN/limitations.md) | [繁體中文](zh-TW/limitations.md) +English | [简体中文](simplified/limitations.md) | [繁體中文](traditional/limitations.md) AgentConfigScore is a deterministic linter and regression gate for persistent coding-agent instructions. Its score measures detected, rule-defined risks. It diff --git a/docs/release-readiness.md b/docs/release-readiness.md index 92d3655..b0d2842 100644 --- a/docs/release-readiness.md +++ b/docs/release-readiness.md @@ -63,8 +63,8 @@ without adding a documentation framework or runtime translation dependency. Initial core documentation: -- `README.zh-CN.md` and `README.zh-TW.md`, with reciprocal language links. -- `docs/zh-CN/` and `docs/zh-TW/` versions of the user guide and limitations, +- `README.simplified.md` and `README.traditional.md`, with reciprocal language links. +- `docs/simplified/` and `docs/traditional/` versions of the user guide and limitations, including the core policy / exception explanations; advanced references remain English. - A translation maintenance note recording the English source revision and explicitly identifying untranslated pages instead of linking empty placeholders. diff --git a/docs/zh-CN/limitations.md b/docs/simplified/limitations.md similarity index 98% rename from docs/zh-CN/limitations.md rename to docs/simplified/limitations.md index fa69f01..23d777b 100644 --- a/docs/zh-CN/limitations.md +++ b/docs/simplified/limitations.md @@ -1,6 +1,6 @@ # 分数含义与限制 -[English](../limitations.md) | 简体中文 | [繁體中文](../zh-TW/limitations.md) · [使用指南](user-guide.md) +[English](../limitations.md) | 简体中文 | [繁體中文](../traditional/limitations.md) · [使用指南](user-guide.md) AgentConfigScore 的分数衡量已经检测到的、由规则定义的风险，不衡量模型智力、任务成功率或指令总体质量。**A 100 表示没有命中生效的确定性规则，不是语义质量或安全认证。** diff --git a/docs/zh-CN/user-guide.md b/docs/simplified/user-guide.md similarity index 97% rename from docs/zh-CN/user-guide.md rename to docs/simplified/user-guide.md index 360d335..d22ef61 100644 --- a/docs/zh-CN/user-guide.md +++ b/docs/simplified/user-guide.md @@ -1,6 +1,6 @@ # 使用指南 -[English](../user-guide.md) | 简体中文 | [繁體中文](../zh-TW/user-guide.md) · [项目主页](../../README.zh-CN.md) +[English](../user-guide.md) | 简体中文 | [繁體中文](../traditional/user-guide.md) · [项目主页](../../README.simplified.md) AgentConfigScore 是本地、确定性的编程助手指令检查器和 PR 回归门禁。它不调用 AI 服务，也不执行指令文件中的命令。100 分不代表指令有用、始终安全或比 AI 审查更好。 diff --git a/docs/zh-TW/limitations.md b/docs/traditional/limitations.md similarity index 97% rename from docs/zh-TW/limitations.md rename to docs/traditional/limitations.md index 933e93f..05ddd97 100644 --- a/docs/zh-TW/limitations.md +++ b/docs/traditional/limitations.md @@ -1,6 +1,6 @@ # 分數意義與限制 -[English](../limitations.md) | [简体中文](../zh-CN/limitations.md) | 繁體中文 · [使用指南](user-guide.md) +[English](../limitations.md) | [简体中文](../simplified/limitations.md) | 繁體中文 · [使用指南](user-guide.md) AgentConfigScore 的分數衡量已偵測到、由規則定義的風險，不衡量模型智力、任務成功率或指令整體品質。**A 100 表示沒有命中生效的確定性規則，不是語意品質或安全認證。** diff --git a/docs/zh-TW/user-guide.md b/docs/traditional/user-guide.md similarity index 97% rename from docs/zh-TW/user-guide.md rename to docs/traditional/user-guide.md index 3e3528a..173f5ae 100644 --- a/docs/zh-TW/user-guide.md +++ b/docs/traditional/user-guide.md @@ -1,6 +1,6 @@ # 使用指南 -[English](../user-guide.md) | [简体中文](../zh-CN/user-guide.md) | 繁體中文 · [專案首頁](../../README.zh-TW.md) +[English](../user-guide.md) | [简体中文](../simplified/user-guide.md) | 繁體中文 · [專案首頁](../../README.traditional.md) AgentConfigScore 是在本機執行、結果確定的開發助手指令檢查工具與 PR 回歸檢查。它不呼叫 AI 服務，也不執行指令檔內的命令。100 分不代表指令實用、始終安全或優於 AI 審查。 diff --git a/docs/translations.md b/docs/translations.md index 41689f1..5689766 100644 --- a/docs/translations.md +++ b/docs/translations.md @@ -1,6 +1,6 @@ # Optional documentation languages -[English](../README.md) | [简体中文](../README.zh-CN.md) | [繁體中文](../README.zh-TW.md) +[English](../README.md) | [简体中文](../README.simplified.md) | [繁體中文](../README.traditional.md) English is the default repository entrypoint and package README. Choosing a different document language does not change CLI output, rule grammar, scores, @@ -12,15 +12,17 @@ providing Chinese documentation. | English source | 简体中文 | 繁體中文 | Scope | |---|---|---|---| -| [README](../README.md) | [Overview](../README.zh-CN.md) | [Overview](../README.zh-TW.md) | Localized core overview, not the entire long English reference | -| [User guide](user-guide.md) | [Guide](zh-CN/user-guide.md) | [Guide](zh-TW/user-guide.md) | Core user journey, all executable examples, exit codes and troubleshooting | -| [Limitations](limitations.md) | [Limits](zh-CN/limitations.md) | [Limits](zh-TW/limitations.md) | Core score contract, rule limits and unestablished accuracy; historic table/manual links stay in English | +| [README](../README.md) | [Overview](../README.simplified.md) | [Overview](../README.traditional.md) | Localized core overview, not the entire long English reference | +| [User guide](user-guide.md) | [Guide](simplified/user-guide.md) | [Guide](traditional/user-guide.md) | Core user journey, all executable examples, exit codes and troubleshooting | +| [Limitations](limitations.md) | [Limits](simplified/limitations.md) | [Limits](traditional/limitations.md) | Core score contract, rule limits and unestablished accuracy; historic table/manual links stay in English | Advanced Action inputs/outputs, precise rule grammars, score-history integrations, release notes, contribution instructions and research protocols remain English. Localized pages identify those links as English instead of creating empty pages. The two Chinese variants are maintained with Simplified and Traditional regional wording rather than changing the program's machine-readable identifiers. +Documentation paths use `simplified` and `traditional` to describe the script +variants rather than a region. ## Source baseline and maintenance diff --git a/docs/user-guide.md b/docs/user-guide.md index e9628c8..2aa84db 100644 --- a/docs/user-guide.md +++ b/docs/user-guide.md @@ -1,6 +1,6 @@ # User guide -English | [简体中文](zh-CN/user-guide.md) | [繁體中文](zh-TW/user-guide.md) +English | [简体中文](simplified/user-guide.md) | [繁體中文](traditional/user-guide.md) AgentConfigScore is a local, deterministic linter and pull-request regression gate for coding-agent instructions. It does not call an AI service or execute diff --git a/tests/test_documentation_languages.py b/tests/test_documentation_languages.py index 21788c3..32ddc9a 100644 --- a/tests/test_documentation_languages.py +++ b/tests/test_documentation_languages.py @@ -8,7 +8,7 @@ ROOT = Path(__file__).resolve().parents[1] -LOCALES = ("zh-CN", "zh-TW") +SCRIPT_VARIANTS = ("simplified", "traditional") def blocks(text, language): @@ -21,26 +21,26 @@ def test_english_stays_the_default_package_readme(self): self.assertIn('readme = "README.md"', project) readme = (ROOT / "README.md").read_text(encoding="utf-8") self.assertIn("English |", readme) - for locale in LOCALES: - self.assertIn(f"README.{locale}.md", readme) - page = (ROOT / f"README.{locale}.md").read_text(encoding="utf-8") + for variant in SCRIPT_VARIANTS: + self.assertIn(f"README.{variant}.md", readme) + page = (ROOT / f"README.{variant}.md").read_text(encoding="utf-8") self.assertIn("[English](README.md)", page) - self.assertIn(f"docs/{locale}/user-guide.md", page) - self.assertIn(f"docs/{locale}/limitations.md", page) + self.assertIn(f"docs/{variant}/user-guide.md", page) + self.assertIn(f"docs/{variant}/limitations.md", page) def test_localized_guides_preserve_every_english_executable_example(self): source = (ROOT / "docs" / "user-guide.md").read_text(encoding="utf-8") expected = blocks(source, "bash") self.assertGreater(len(expected), 5) - for locale in LOCALES: - with self.subTest(locale=locale): - page = (ROOT / "docs" / locale / "user-guide.md").read_text(encoding="utf-8") + for variant in SCRIPT_VARIANTS: + with self.subTest(variant=variant): + page = (ROOT / "docs" / variant / "user-guide.md").read_text(encoding="utf-8") self.assertEqual(blocks(page, "bash"), expected) for code in ("--max-drop", "--fail-on-new-errors", "--json", "--sarif", "--force"): self.assertIn(code, page) def test_overviews_use_the_same_commands_config_and_workflow(self): - pages = [(ROOT / f"README.{locale}.md").read_text(encoding="utf-8") for locale in LOCALES] + pages = [(ROOT / f"README.{variant}.md").read_text(encoding="utf-8") for variant in SCRIPT_VARIANTS] for language in ("bash", "json", "yaml"): with self.subTest(language=language): self.assertEqual(blocks(pages[0], language), blocks(pages[1], language)) @@ -52,10 +52,13 @@ def test_overviews_use_the_same_commands_config_and_workflow(self): self.assertIn("LE0-Lin/AgentConfigScore@v0.23.0", workflow) def test_localized_links_target_real_files_inside_the_repository(self): - paths = [ROOT / f"README.{locale}.md" for locale in LOCALES] - paths += [ROOT / "docs" / locale / name for locale in LOCALES + paths = [ROOT / f"README.{variant}.md" for variant in SCRIPT_VARIANTS] + paths += [ROOT / "docs" / variant / name for variant in SCRIPT_VARIANTS for name in ("user-guide.md", "limitations.md")] - paths += [ROOT / "docs" / "translations.md"] + paths += [ROOT / "README.md"] + paths += [ROOT / "docs" / name for name in + ("README.md", "user-guide.md", "limitations.md", "translations.md", + "release-readiness.md")] for path in paths: text = path.read_text(encoding="utf-8") for destination in re.findall(r"!?\[[^\]\n]+\]\(([^)\n]+)\)", text): @@ -68,8 +71,8 @@ def test_localized_links_target_real_files_inside_the_repository(self): self.assertTrue(target.is_file(), target) def test_core_limits_keep_stable_rule_ids_and_source_scope_visible(self): - for locale in LOCALES: - page = (ROOT / "docs" / locale / "limitations.md").read_text(encoding="utf-8") + for variant in SCRIPT_VARIANTS: + page = (ROOT / "docs" / variant / "limitations.md").read_text(encoding="utf-8") for code in ("rm-rf", "prompt-injection-override", "false-success-report", "broad-environment-upload", "no-config", "empty-instructions", "instruction-file-removed", "directive-polarity-flip"):