[PR #3113] docs(readme): sync Simplified Chinese README with current English prerequisites #5628

Open
opened 2026-10-31 01:08:06 +00:00 by bsakaguchi · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/3113
Author: @MbappeWU
Created: 10/14/2026
Status: 🔄 Open

Base: main ← Head: docs/zh-readme-linux-procps


📝 Commits (9)

  • 5cb6e56 docs(readme): sync Simplified Chinese README with current English prerequisites
  • 01260bc Merge upstream/main into docs/zh-readme-linux-procps
  • 6dd8447 Merge upstream/main into docs/zh-readme-linux-procps
  • 132cabc Merge upstream/main into docs/zh-readme-linux-procps
  • 5d2baaf Merge upstream/main into docs/zh-readme-linux-procps
  • 7d2a62f Merge upstream/main into docs/zh-readme-linux-procps
  • 259f2fa Merge upstream/main into docs/zh-readme-linux-procps
  • cdd5e8b Merge upstream/main into docs/zh-readme-linux-procps
  • 53aeed0 docs(readme): narrow zh README to remaining gaps vs main

📊 Changes

1 file changed (+16 additions, -14 deletions)

View changed files

📝 docs/readme/README_zh.md (+16 -14)

📄 Description

Summary

The Simplified Chinese README (docs/readme/README_zh.md) had fallen behind README.md on several user-facing facts. Most importantly, it did not mention that Linux needs a procps-compatible ps on REA's PATH (added to the English README in "docs(installation): document Linux procps prerequisite"), so Chinese readers on Linux could hit the owned-process check failure without any hint. This PR syncs only substantive content; no cosmetic rewording.

Problem and expected behavior

A reader following README_zh.md on Linux was missing a required prerequisite and several capability/requirement rows present in README.md. Expected: the translation states the same prerequisites, rows, and provider notes as the English README.

Change and scope

Each change mirrors a line in README.md:

  • Quick start: Linux procps-compatible ps requirement for Ghidra, JADX, firmware tools, and static JavaScript/Electron analysis (README.md lines 67–70).
  • "What you can analyze" table: JavaScript/Electron row gains the Linux ps requirement; Rust row translated (was left in English) and reordered after Go; new SQLite row; Fiddler Everywhere SAZ in saved network captures; packet-summaries row renamed and marked Linux-verified, placed after packet captures; .NET requirement reads "none (static inspection only)".
  • Paragraph on caller-provided GNU objdump and Rizin after the table; the duplicate top-nav link to that guide is removed, matching the English nav line.
  • Provider paragraph: optional native IDA MCP bridge and REA_GHIDRA_STARTUP_TIMEOUT_MS / REA_HOPPER_STARTUP_TIMEOUT_MS.
  • Hopper FAQ: finish the macOS first-run prompt in the same user session before the first CLI/MCP operation or unattended task.
  • Troubleshooting FAQ: rea update applies to CLIs installed with npm install --global or bun add --global.

Commands blocks and version numbers are unchanged. Not included: other translations.

Follow the contribution scope. Ordinary documentation fix within existing boundaries; scope decision not applicable.

Contract and boundary impact

  • Semantic owner and earliest changed stage: documentation (docs/readme/README_zh.md) only.

  • Contribution scope fit and linked maintainer decision: documentation correction; not applicable.

  • CLI and MCP/tool-catalog contract: none.

  • Provider, bridge, target-format, or platform compatibility: none.

  • Evidence, artifact, provenance, or reconstruction contract: none.

  • Target selection, authority, upstream behavior, and cleanup details (if applicable): not applicable.

  • Generated metadata (docs/public/product-catalog.json), package, or installation impact: none; no generated files committed.

  • Read existing files or captured data.

  • Launch or attach to a process.

  • Inject instrumentation or run scripts/code.

  • Change process memory, registers, files, or configuration.

  • Contact network services.

  • Recover protected code or work around protections.

  • Documentation or usability only; no target interaction.

  • Not sure yet; investigation or maintainer guidance needed.

Evidence and regression coverage

Executed locally on Linux x64, Node.js 22.20.0, base f353474, after npm ci --ignore-scripts, npm run build, and npm run docs:generate:

  • npx vitest run tests/conformance/readmeConsistency.test.ts tests/boundary/filesystem/productCatalog.test.ts: 15 passed, 1 failed. The failing case, canonical product catalog drift > keeps translated readmes linked to canonical setup and tool details (expects https://rea.tools/zh-CN/guides/native/), fails identically on the unmodified base checkout, so it is pre-existing and not caused by this change.

  • Link check using the docs-facts.mjs normalization: 90 links in each README, 0 link-target differences, all 60 relative file targets exist; bash blocks identical to README.md.

  • npx prettier --check docs/readme/README_zh.md: passes.

  • Tests added or updated: none (documentation-only).

  • Unavailable coverage: full npm run docs:check / CI suite not run locally.

Author readiness

Human owner: @MbappeWU

  • I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work.
  • I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps.
  • I declare this PR ready for initial maintainer review.

🔄 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/3113 **Author:** [@MbappeWU](https://github.com/MbappeWU) **Created:** 10/14/2026 **Status:** 🔄 Open **Base:** `main` ← **Head:** `docs/zh-readme-linux-procps` --- ### 📝 Commits (9) - [`5cb6e56`](https://github.com/morluto/rea/commit/5cb6e569965392358c47ccfcf7f344e7b01dfd22) docs(readme): sync Simplified Chinese README with current English prerequisites - [`01260bc`](https://github.com/morluto/rea/commit/01260bc8617241f22a05e6f0ed2b50fd545f24e7) Merge upstream/main into docs/zh-readme-linux-procps - [`6dd8447`](https://github.com/morluto/rea/commit/6dd8447524d2ad140ed5ddc4345b175af2ab4cbf) Merge upstream/main into docs/zh-readme-linux-procps - [`132cabc`](https://github.com/morluto/rea/commit/132cabc46ab91b6d2b321e292f3d5a6e344ea7eb) Merge upstream/main into docs/zh-readme-linux-procps - [`5d2baaf`](https://github.com/morluto/rea/commit/5d2baaf1f14f5f242ed21e4f773c3d69700e54eb) Merge upstream/main into docs/zh-readme-linux-procps - [`7d2a62f`](https://github.com/morluto/rea/commit/7d2a62fcb7e3c6912a1f8b52105b4bf4dca86c2d) Merge upstream/main into docs/zh-readme-linux-procps - [`259f2fa`](https://github.com/morluto/rea/commit/259f2faf747f03199b78c335396a0ca35e2db131) Merge upstream/main into docs/zh-readme-linux-procps - [`cdd5e8b`](https://github.com/morluto/rea/commit/cdd5e8bee5433df80065ef72d29bf83bf8a7d372) Merge upstream/main into docs/zh-readme-linux-procps - [`53aeed0`](https://github.com/morluto/rea/commit/53aeed0521d090aa1233a727e121412f01f300de) docs(readme): narrow zh README to remaining gaps vs main ### 📊 Changes **1 file changed** (+16 additions, -14 deletions) <details> <summary>View changed files</summary> 📝 `docs/readme/README_zh.md` (+16 -14) </details> ### 📄 Description ## Summary The Simplified Chinese README (`docs/readme/README_zh.md`) had fallen behind `README.md` on several user-facing facts. Most importantly, it did not mention that Linux needs a procps-compatible `ps` on REA's `PATH` (added to the English README in "docs(installation): document Linux procps prerequisite"), so Chinese readers on Linux could hit the owned-process check failure without any hint. This PR syncs only substantive content; no cosmetic rewording. ## Problem and expected behavior A reader following `README_zh.md` on Linux was missing a required prerequisite and several capability/requirement rows present in `README.md`. Expected: the translation states the same prerequisites, rows, and provider notes as the English README. ## Change and scope Each change mirrors a line in `README.md`: - Quick start: Linux procps-compatible `ps` requirement for Ghidra, JADX, firmware tools, and static JavaScript/Electron analysis (README.md lines 67–70). - "What you can analyze" table: JavaScript/Electron row gains the Linux `ps` requirement; Rust row translated (was left in English) and reordered after Go; new SQLite row; Fiddler Everywhere SAZ in saved network captures; packet-summaries row renamed and marked Linux-verified, placed after packet captures; .NET requirement reads "none (static inspection only)". - Paragraph on caller-provided GNU objdump and Rizin after the table; the duplicate top-nav link to that guide is removed, matching the English nav line. - Provider paragraph: optional native IDA MCP bridge and `REA_GHIDRA_STARTUP_TIMEOUT_MS` / `REA_HOPPER_STARTUP_TIMEOUT_MS`. - Hopper FAQ: finish the macOS first-run prompt in the same user session before the first CLI/MCP operation or unattended task. - Troubleshooting FAQ: `rea update` applies to CLIs installed with `npm install --global` or `bun add --global`. Commands blocks and version numbers are unchanged. Not included: other translations. Follow the [contribution scope](https://github.com/morluto/rea/blob/main/CONTRIBUTING.md#contribution-scope). Ordinary documentation fix within existing boundaries; scope decision not applicable. ## Contract and boundary impact - Semantic owner and earliest changed stage: documentation (`docs/readme/README_zh.md`) only. - Contribution scope fit and linked maintainer decision: documentation correction; not applicable. - CLI and MCP/tool-catalog contract: none. - Provider, bridge, target-format, or platform compatibility: none. - Evidence, artifact, provenance, or reconstruction contract: none. - Target selection, authority, upstream behavior, and cleanup details (if applicable): not applicable. - Generated metadata (`docs/public/product-catalog.json`), package, or installation impact: none; no generated files committed. - [ ] Read existing files or captured data. - [ ] Launch or attach to a process. - [ ] Inject instrumentation or run scripts/code. - [ ] Change process memory, registers, files, or configuration. - [ ] Contact network services. - [ ] Recover protected code or work around protections. - [x] Documentation or usability only; no target interaction. - [ ] Not sure yet; investigation or maintainer guidance needed. ## Evidence and regression coverage Executed locally on Linux x64, Node.js 22.20.0, base `f353474`, after `npm ci --ignore-scripts`, `npm run build`, and `npm run docs:generate`: - `npx vitest run tests/conformance/readmeConsistency.test.ts tests/boundary/filesystem/productCatalog.test.ts`: 15 passed, 1 failed. The failing case, `canonical product catalog drift > keeps translated readmes linked to canonical setup and tool details` (expects `https://rea.tools/zh-CN/guides/native/`), fails identically on the unmodified base checkout, so it is pre-existing and not caused by this change. - Link check using the `docs-facts.mjs` normalization: 90 links in each README, 0 link-target differences, all 60 relative file targets exist; `bash` blocks identical to `README.md`. - `npx prettier --check docs/readme/README_zh.md`: passes. - Tests added or updated: none (documentation-only). - Unavailable coverage: full `npm run docs:check` / CI suite not run locally. ## Author readiness <!-- Left for the human owner to complete, per CONTRIBUTING.md#pull-request-ownership-and-readiness. --> Human owner: @MbappeWU - [x] I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work. - [x] I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps. - [x] I declare this PR ready for initial maintainer review. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
Sign in to join this conversation.
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#5628
No description provided.