morluto/rea

Fork 0

mirror of https://github.com/morluto/rea.git synced 2026-11-05 07:47:29 +00:00

[PR #2119] [MERGED] docs: update Chinese README guides #5042

New issue

Closed

opened 2026-10-31 01:00:16 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-31 01:00:16 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/2119
Author: @lg114
Created: 10/12/2026
Status: ✅ Merged
Merged: 10/13/2026
Merged by: @morluto

Base: main ← Head: docsfix

📝 Commits (3)

139e956 Update Chinese README docs
ca7e231 docs: refresh Chinese guides without changing source pins
a3eeff8 docs: preserve Chinese guides after README relocation

📊 Changes

2 files changed (+14 additions, -6 deletions)

View changed files

📝 docs/readme/README_zh-TW.md (+7 -3)
📝 docs/readme/README_zh.md (+7 -3)

📄 Description

docs(readme): sync Chinese README with IDA, Bun, Go, and WASM entries

Summary

The simplified Chinese (README_zh.md) and traditional Chinese (README_zh-TW.md) README files had drifted from the English main README in three areas: the native analysis engine list, the Bun-based CLI install/update workflow, and the capability table. This PR brings both translations back in line.

Problem and expected behavior

After recent English README updates that added IDA as a supported native analysis backend, documented Bun global CLI installation/update, and added Go binary and WASM artifact rows to the capability table, the Chinese translations still referenced only "Hopper or Ghidra" in body text, omitted Bun entirely from the update section, and lacked the two new table rows. Chinese-reading users and agents following these READMEs would miss supported targets and install paths.

Change and scope

Three targeted edits per file, no structural changes:

Line 54 body text — "Hopper 或 Ghidra" → "Hopper、Ghidra 或 IDA"; "不需要这两个引擎" → "不需要原生分析引擎" (matching the English "needs no native analysis engine").
"更新 REA" section — Added bun add --global alongside npm install --global, the Bun ≥ 1.2.17 minimum-version paragraph, and the bunx rea-agents@latest one-off usage note.
"可以分析什么/什麼" table — Inserted Go 二进制文件/二進位檔案 and WASM 工件 rows between "离线 ELF 布局" and "EVM 字节码", matching the English table order.

Intentionally not changed: the existing localization choices (简中 "智能体" vs 繁中 "AI 代理"), star history count, disclaimer text, and website locale URLs — these were already correctly synced.

Contract and boundary impact

Semantic owner and earliest changed stage: not applicable — documentation only, no runtime code.
CLI and MCP/tool-catalog contract: none.
Provider, bridge, target-format, or platform compatibility: none — the underlying capabilities already exist; only the translated descriptions were missing.
Evidence, artifact, provenance, or reconstruction contract: none.
Process execution, authorization, cleanup, or containment impact: none.
Generated metadata (docs/public/product-catalog.json), package, or installation impact: none.

Evidence and regression coverage

Tests added or updated: not applicable — prose-only change.
Base reproduction or other evidence: visual diff review against README.md lines 54, 108–133, 153–158.
User-visible CLI/MCP output (if applicable): not applicable.
Remaining proof gaps: none.

Validation performed

git diff HEAD~1 --stat — 2 files changed, 16 insertions, 8 deletions (README_zh.md and README_zh-TW.md only).
Manual row-by-row comparison of the Chinese tables against the English table at README.md:153–171 — row count and order now match.
Verified Bun paragraph placement matches README.md:119–120 and README.md:132–133.

Compatibility, safety, and release

Breaking changes or migration steps: none.
Real Hopper/Ghidra, browser, or OS coverage: not applicable — no runtime changes.
Package or release metadata impact: none.
Security, privacy, process, or containment review: not applicable.

Review checklist

This PR addresses a concrete problem or an agreed enhancement.
The PR has one focused outcome and the title follows type(scope): outcome.
Related issue is linked, or the reason for not linking one is stated above.
Tests cover changed observable behavior and meaningful failure paths. — N/A (prose only)
Owning docs, contracts, and generated metadata are updated where needed.
User-visible CLI/MCP changes include representative output. — N/A
I checked the final diff for secrets, unrelated cleanup, and unsupported claims.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/morluto/rea/pull/2119 **Author:** [@lg114](https://github.com/lg114) **Created:** 10/12/2026 **Status:** ✅ Merged **Merged:** 10/13/2026 **Merged by:** [@morluto](https://github.com/morluto) **Base:** `main` ← **Head:** `docsfix` --- ### 📝 Commits (3) - [`139e956`](https://github.com/morluto/rea/commit/139e95600213ce273826c90df8dcee994930ded8) Update Chinese README docs - [`ca7e231`](https://github.com/morluto/rea/commit/ca7e2315f87dc4b69e2a88d5c0fc7f71015fe0b9) docs: refresh Chinese guides without changing source pins - [`a3eeff8`](https://github.com/morluto/rea/commit/a3eeff864b6cc01f29e70462a84a9f01c54235ac) docs: preserve Chinese guides after README relocation ### 📊 Changes **2 files changed** (+14 additions, -6 deletions) <details> <summary>View changed files</summary> 📝 `docs/readme/README_zh-TW.md` (+7 -3) 📝 `docs/readme/README_zh.md` (+7 -3) </details> ### 📄 Description docs(readme): sync Chinese README with IDA, Bun, Go, and WASM entries ## Summary The simplified Chinese (`README_zh.md`) and traditional Chinese (`README_zh-TW.md`) README files had drifted from the English main README in three areas: the native analysis engine list, the Bun-based CLI install/update workflow, and the capability table. This PR brings both translations back in line. ## Problem and expected behavior After recent English README updates that added IDA as a supported native analysis backend, documented Bun global CLI installation/update, and added Go binary and WASM artifact rows to the capability table, the Chinese translations still referenced only "Hopper or Ghidra" in body text, omitted Bun entirely from the update section, and lacked the two new table rows. Chinese-reading users and agents following these READMEs would miss supported targets and install paths. ## Change and scope Three targeted edits per file, no structural changes: 1. **Line 54 body text** — "Hopper 或 Ghidra" → "Hopper、Ghidra 或 IDA"; "不需要这两个引擎" → "不需要原生分析引擎" (matching the English "needs no native analysis engine"). 2. **"更新 REA" section** — Added `bun add --global` alongside `npm install --global`, the Bun ≥ 1.2.17 minimum-version paragraph, and the `bunx rea-agents@latest` one-off usage note. 3. **"可以分析什么/什麼" table** — Inserted Go 二进制文件/二進位檔案 and WASM 工件 rows between "离线 ELF 布局" and "EVM 字节码", matching the English table order. Intentionally not changed: the existing localization choices (简中 "智能体" vs 繁中 "AI 代理"), star history count, disclaimer text, and website locale URLs — these were already correctly synced. ## Contract and boundary impact - Semantic owner and earliest changed stage: not applicable — documentation only, no runtime code. - CLI and MCP/tool-catalog contract: none. - Provider, bridge, target-format, or platform compatibility: none — the underlying capabilities already exist; only the translated descriptions were missing. - Evidence, artifact, provenance, or reconstruction contract: none. - Process execution, authorization, cleanup, or containment impact: none. - Generated metadata (`docs/public/product-catalog.json`), package, or installation impact: none. ## Evidence and regression coverage - Tests added or updated: not applicable — prose-only change. - Base reproduction or other evidence: visual diff review against `README.md` lines 54, 108–133, 153–158. - User-visible CLI/MCP output (if applicable): not applicable. - Remaining proof gaps: none. ## Validation performed - `git diff HEAD~1 --stat` — 2 files changed, 16 insertions, 8 deletions (`README_zh.md` and `README_zh-TW.md` only). - Manual row-by-row comparison of the Chinese tables against the English table at `README.md:153–171` — row count and order now match. - Verified Bun paragraph placement matches `README.md:119–120` and `README.md:132–133`. ## Compatibility, safety, and release - Breaking changes or migration steps: none. - Real Hopper/Ghidra, browser, or OS coverage: not applicable — no runtime changes. - Package or release metadata impact: none. - Security, privacy, process, or containment review: not applicable. ## Review checklist - [x] This PR addresses a concrete problem or an agreed enhancement. - [x] The PR has one focused outcome and the title follows `type(scope): outcome`. - [x] Related issue is linked, or the reason for not linking one is stated above. - [x] Tests cover changed observable behavior and meaningful failure paths. — N/A (prose only) - [x] Owning docs, contracts, and generated metadata are updated where needed. - [x] User-visible CLI/MCP changes include representative output. — N/A - [x] I checked the final diff for secrets, unrelated cleanup, and unsupported claims. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-31 01:00:16 +00:00

closed this issue
added the
pull-request
label

bsakaguchi referenced this issue

2026-11-01 21:42:48 +00:00

[PR #5042] feat(example): add editable Civic Atlas graph #6754

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

morluto/rea#5042

No description provided.

Rows
Columns