morluto/rea

Fork 0

mirror of https://github.com/morluto/rea.git synced 2026-11-05 06:45:22 +00:00

[PR #1018] [CLOSED] docs(readme): polish the Simplified Chinese README and sync it with English #2584

New issue

Closed

opened 2026-10-17 21:07:52 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-17 21:07:52 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/1018
Author: @akram1089
Created: 10/7/2026
Status: ❌ Closed

Base: main ← Head: docs/958-readme-zh

📝 Commits (1)

78f3ff8 docs(readme): polish the Simplified Chinese README and sync it with English

📊 Changes

1 file changed (+74 additions, -70 deletions)

View changed files

📝 README_zh.md (+74 -70)

📄 Description

Summary

Refs #958 (Chinese item). This is one of four per-language PRs, so each language can be reviewed and merged on its own.

This PR polishes README_zh.md and corrects the places where it disagreed with the current English README and the source docs. It keeps the existing structure and the condensed scope of the translation. This is a review and sync, not a re-translation.

Problem and expected behavior

Incremental updates left the Chinese README with some outdated or incorrect technical statements and inconsistent terminology. Expected: natural zh-CN prose that agrees with README.md on setup, CLI/MCP usage, providers, and coverage boundaries.

Change and scope

Technical corrections

Android verification platform: "真机验证覆盖 Linux" was incorrect. It now says static APK inspection supports Linux and macOS, and that the current metadata bridge is verified on macOS arm64 with headless JADX (English "Current status"; docs/android-analysis.md).
IDA Pro listed as a provider: "原生二进制分析需要 Hopper 或 Ghidra" now names Hopper, Ghidra, or IDA Pro, and notes that Ghidra and IDA are bring-your-own (English "Requirements").
Current status:
- Added the "native binaries" bullet: Mach-O/ELF/PE/.app through a selected deep provider, IDA read-only function and string operations, and Hopper .hop support.
- Added the macOS/Linux support sentence.
- rea capabilities / rea providers scope now mentions binary_session tool availability.
Ghidra editing: "原子化的会话级函数注释" now reads function name and entry-comment edits, and "Windows P0 为只读" now reads that Windows P0 has no mutation authority (English line "Linux/macOS Ghidra additionally supports ...").
Security model and FAQ:
- Removed the outdated "仅限当前用户的 Unix 套接字" and "通过本地 Unix 套接字把操作交给 Hopper".
- The text now says authenticated private local sockets for Hopper and Ghidra, and the configured local MCP registration for IDA.
- The FAQ now says current providers analyze and capture locally.
Uninstall: it now states that only REA-owned MCP registrations and the managed skill are removed, lists what is preserved, and says --purge-data affects only ~/.rea/cache and ~/.rea/state.
Mermaid diagram:
- The Ghidra node is no longer labelled read-only only and now includes annotations.
- Added the IDA MCP node, matching the English diagram.
Static JavaScript first result: replaced "这条静态流程支持此类路径" with what the command returns: inline Evidence, the recovered graph, limitations, and unknowns. It now also says no MCP, Hopper, or Ghidra is needed, the app is not executed, and doctor is not a per-analysis prerequisite.
Roadmap paragraph: synced to English Now/Next/Later, including that IDA support already ships.
Smaller syncs:
- The npm requirement is now its own line; REA does not require a particular npm version.
- The --help sentence now mentions bounded search.
- The Hopper close behavior now mentions cleanup_incomplete.
- The tool-catalog row text now includes "Android/Apple 清单投影" and "传入静态引用".
- The mislabelled [英文支持指南](README.md#current-status) link text is fixed; its target is unchanged.

Prose improvements

Terminology:
- agent is always 智能体 (stray 客户端 removed).
- provider is 分析提供方 (the model vendor stays 模型服务商).
- bridge is 桥接.
- skill is 技能（skill） on first use.
Full-width punctuation in prose and consistent Chinese/Latin spacing.
Rewrote stiff or literal sentences, for example "请先确认发布边界，再假定旧版 npm 包具备该能力", "使人与智能体的分析互相增强", and the setup-selection paragraph.

Not included

These English sections are still absent from the condensed translation and were left out on purpose. They can be added in follow-up PRs if wanted:

Readiness scopes, plus the full Ghidra and IDA Pro sections.
CLI or agent?, Showcase, and website/CDP/browser-scenario/V8 Inspector.
Choosing a provider, CLI exit status, Process Capture, and some FAQ entries.

Contract and boundary impact

Semantic owner and earliest changed stage: documentation only (README_zh.md)
CLI and MCP/tool-catalog contract: none
Provider, bridge, target-format, or platform compatibility: none
Evidence, artifact, provenance, or reconstruction contract: none
Process execution, authorization, cleanup, or containment impact: none
Generated metadata (docs/product-catalog.json), package, or installation impact: none. The release-please version block, badges, client names, requirement strings, and tool-family counts are unchanged.

Evidence and regression coverage

Tests added or updated: none (docs only)
Base reproduction or other evidence: each technical correction is traced to the current README.md or the named guide above.
User-visible CLI/MCP output: not applicable
Remaining proof gaps: no fluent native-speaker review yet. A zh-CN reviewer pass is requested before merge.

Validation performed

npx vitest run tests/conformance/readmeConsistency.test.ts: 9 passed
documentationFactIssues from scripts/lib/docs-facts.mjs against docs/product-catalog.json: no issues (tool-family counts, client names, badge)
npx oxfmt --check README_zh.md: formatted
A local link check over every relative link and in-page anchor in README_zh.md: all resolve

Compatibility, safety, and release

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

Review checklist

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.
Owning docs, contracts, and generated metadata are updated where needed.
User-visible CLI/MCP changes include representative output.
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/1018 **Author:** [@akram1089](https://github.com/akram1089) **Created:** 10/7/2026 **Status:** ❌ Closed **Base:** `main` ← **Head:** `docs/958-readme-zh` --- ### 📝 Commits (1) - [`78f3ff8`](https://github.com/morluto/rea/commit/78f3ff85ef8e20a51998aca41de2405b1cd3fd28) docs(readme): polish the Simplified Chinese README and sync it with English ### 📊 Changes **1 file changed** (+74 additions, -70 deletions) <details> <summary>View changed files</summary> 📝 `README_zh.md` (+74 -70) </details> ### 📄 Description ## Summary Refs #958 (Chinese item). This is one of four per-language PRs, so each language can be reviewed and merged on its own. This PR polishes `README_zh.md` and corrects the places where it disagreed with the current English README and the source docs. It keeps the existing structure and the condensed scope of the translation. This is a review and sync, not a re-translation. ## Problem and expected behavior Incremental updates left the Chinese README with some outdated or incorrect technical statements and inconsistent terminology. Expected: natural zh-CN prose that agrees with `README.md` on setup, CLI/MCP usage, providers, and coverage boundaries. ## Change and scope ### Technical corrections - **Android verification platform:** "真机验证覆盖 Linux" was incorrect. It now says static APK inspection supports Linux and macOS, and that the current metadata bridge is verified on macOS arm64 with headless JADX (English "Current status"; `docs/android-analysis.md`). - **IDA Pro listed as a provider:** "原生二进制分析需要 Hopper 或 Ghidra" now names Hopper, Ghidra, or IDA Pro, and notes that Ghidra and IDA are bring-your-own (English "Requirements"). - **Current status:** - Added the "native binaries" bullet: Mach-O/ELF/PE/`.app` through a selected deep provider, IDA read-only function and string operations, and Hopper `.hop` support. - Added the macOS/Linux support sentence. - `rea capabilities` / `rea providers` scope now mentions `binary_session` tool availability. - **Ghidra editing:** "原子化的会话级函数注释" now reads function name and entry-comment edits, and "Windows P0 为只读" now reads that Windows P0 has no mutation authority (English line "Linux/macOS Ghidra additionally supports ..."). - **Security model and FAQ:** - Removed the outdated "仅限当前用户的 Unix 套接字" and "通过本地 Unix 套接字把操作交给 Hopper". - The text now says authenticated private local sockets for Hopper and Ghidra, and the configured local MCP registration for IDA. - The FAQ now says current providers analyze and capture locally. - **Uninstall:** it now states that only REA-owned MCP registrations and the managed skill are removed, lists what is preserved, and says `--purge-data` affects only `~/.rea/cache` and `~/.rea/state`. - **Mermaid diagram:** - The Ghidra node is no longer labelled read-only only and now includes annotations. - Added the IDA MCP node, matching the English diagram. - **Static JavaScript first result:** replaced "这条静态流程支持此类路径" with what the command returns: inline Evidence, the recovered graph, limitations, and unknowns. It now also says no MCP, Hopper, or Ghidra is needed, the app is not executed, and `doctor` is not a per-analysis prerequisite. - **Roadmap paragraph:** synced to English Now/Next/Later, including that IDA support already ships. - **Smaller syncs:** - The npm requirement is now its own line; REA does not require a particular npm version. - The `--help` sentence now mentions bounded search. - The Hopper close behavior now mentions `cleanup_incomplete`. - The tool-catalog row text now includes "Android/Apple 清单投影" and "传入静态引用". - The mislabelled `[英文支持指南](README.md#current-status)` link text is fixed; its target is unchanged. ### Prose improvements - **Terminology:** - agent is always 智能体 (stray 客户端 removed). - provider is 分析提供方 (the model vendor stays 模型服务商). - bridge is 桥接. - skill is 技能（skill） on first use. - Full-width punctuation in prose and consistent Chinese/Latin spacing. - Rewrote stiff or literal sentences, for example "请先确认发布边界，再假定旧版 npm 包具备该能力", "使人与智能体的分析互相增强", and the setup-selection paragraph. ### Not included These English sections are still absent from the condensed translation and were left out on purpose. They can be added in follow-up PRs if wanted: - Readiness scopes, plus the full Ghidra and IDA Pro sections. - CLI or agent?, Showcase, and website/CDP/browser-scenario/V8 Inspector. - Choosing a provider, CLI exit status, Process Capture, and some FAQ entries. ## Contract and boundary impact - Semantic owner and earliest changed stage: documentation only (`README_zh.md`) - CLI and MCP/tool-catalog contract: none - Provider, bridge, target-format, or platform compatibility: none - Evidence, artifact, provenance, or reconstruction contract: none - Process execution, authorization, cleanup, or containment impact: none - Generated metadata (`docs/product-catalog.json`), package, or installation impact: none. The release-please version block, badges, client names, requirement strings, and tool-family counts are unchanged. ## Evidence and regression coverage - Tests added or updated: none (docs only) - Base reproduction or other evidence: each technical correction is traced to the current `README.md` or the named guide above. - User-visible CLI/MCP output: not applicable - Remaining proof gaps: **no fluent native-speaker review yet.** A zh-CN reviewer pass is requested before merge. ## Validation performed - `npx vitest run tests/conformance/readmeConsistency.test.ts`: 9 passed - `documentationFactIssues` from `scripts/lib/docs-facts.mjs` against `docs/product-catalog.json`: no issues (tool-family counts, client names, badge) - `npx oxfmt --check README_zh.md`: formatted - A local link check over every relative link and in-page anchor in `README_zh.md`: all resolve ## Compatibility, safety, and release - Breaking changes or migration steps: none - Real Hopper/Ghidra, browser, or OS coverage: not applicable - Package or release metadata impact: none - Security, privacy, process, or containment review: no secrets or private paths ## Review checklist - [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. - [x] Owning docs, contracts, and generated metadata are updated where needed. - [x] User-visible CLI/MCP changes include representative output. - [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-17 21:07:52 +00:00

closed this issue
added the
pull-request
label

bsakaguchi referenced this issue

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

[GH-ISSUE #6810] [Bug] Managed runtime classification hides ReadyToRun behind assembly hints #4158

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#2584

No description provided.

Rows
Columns