morluto/rea

Fork 0

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

[PR #1020] [CLOSED] docs(readme): polish the Korean README and sync it with English #2585

New issue

Closed

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

bsakaguchi commented

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

Owner

📋 Pull Request Information

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

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

📝 Commits (1)

57ded2d docs(readme): polish the Korean README and sync it with English

📊 Changes

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

View changed files

📝 README_ko.md (+82 -74)

📄 Description

Summary

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

This PR polishes README_ko.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

The Korean README contained outdated or incorrect technical statements, mixed terminology for "provider", and some literal phrasing. Expected: natural 합니다체 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 metadata bridge is verified on macOS arm64 with headless JADX (English "Current status"; docs/android-analysis.md).
IDA Pro listed as a provider: the requirements now name Hopper, Ghidra, or IDA Pro, note that Ghidra and IDA are bring-your-own, and link the IDA guide.
Setup intro: Setup registers REA and installs version-matched workflow instructions, and static JavaScript analysis needs neither engine.
Requirements:
- The npm requirement is now its own line.
- Added that static JavaScript needs only the Node/npm runtime.
Current status:
- Added the "native binaries" bullet: Mach-O/ELF/PE/.app, IDA read-only function and string operations, and Hopper .hop.
- Kept the 25 read-only Ghidra operations on Linux x64, macOS, and Windows P0.
- Spelled out the Windows P0 target boundary.
- rea capabilities / rea providers scope now mentions binary_session tool availability.
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 local MCP registration for IDA.
- Added the Windows P0 native controls and the macOS Accessibility/Screen Recording note.
Uninstall: only REA-owned MCP registrations and the managed skill are removed; Hopper, Node.js, Evidence, and other servers are preserved; and --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.
How it works: shared workflows and Evidence contracts; providers declare capabilities and side effects; MCP sessions keep the active target and Evidence ledger.
Roadmap: replaced the old list, which presented already-shipped reconstruction checks as future work, with the English Now/Next/Later summary. It now notes IDA support already ships.
Static JavaScript first result: now says what the command returns and that doctor is not a per-analysis prerequisite.
Tool catalog row text: added Android/Apple inventory projections and "들어오는 정적 참조" (incoming static references).

Prose improvements

Terminology:
- provider is always 제공자 (공급자 removed; 공급업체 kept only for vendor).
- Also unified 의존성, 에셋, 인벤토리, and 내 제품.
- Evidence stays as the product term.
Consistent 합니다체, plus fixes to spacing and particles (for example ASAR라면 became ASAR 파일은).
Rewrote literal sentences, for example REA는 분석을 바이너리 증거에 근거하게 합니다 and the setup-selection paragraph.

Not included

These English sections are still absent from the condensed translation and can be added in follow-up PRs if wanted:

Readiness scopes, Linux install details, and the Ghidra and IDA Pro sections.
CLI or agent?, Showcase, and website/CDP/browser-scenario/V8 Inspector.
Choosing a provider, CLI exit status, and Process Capture.

Contract and boundary impact

Semantic owner and earliest changed stage: documentation only (README_ko.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.
User-visible CLI/MCP output: not applicable
Remaining proof gaps: no fluent native-speaker review yet. A Korean 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
npx oxfmt --check README_ko.md: formatted
A local link check over every relative link and in-page anchor in README_ko.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/1020 **Author:** [@akram1089](https://github.com/akram1089) **Created:** 10/7/2026 **Status:** ❌ Closed **Base:** `main` ← **Head:** `docs/958-readme-ko` --- ### 📝 Commits (1) - [`57ded2d`](https://github.com/morluto/rea/commit/57ded2de5519901948e531c61e4124861ab1f42b) docs(readme): polish the Korean README and sync it with English ### 📊 Changes **1 file changed** (+82 additions, -74 deletions) <details> <summary>View changed files</summary> 📝 `README_ko.md` (+82 -74) </details> ### 📄 Description ## Summary Refs #958 (Korean item). This is one of four per-language PRs, so each language can be reviewed and merged on its own. This PR polishes `README_ko.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 The Korean README contained outdated or incorrect technical statements, mixed terminology for "provider", and some literal phrasing. Expected: natural 합니다체 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 metadata bridge is verified on macOS arm64 with headless JADX (English "Current status"; `docs/android-analysis.md`). - **IDA Pro listed as a provider:** the requirements now name Hopper, Ghidra, or IDA Pro, note that Ghidra and IDA are bring-your-own, and link the IDA guide. - **Setup intro:** Setup registers REA and installs version-matched workflow instructions, and static JavaScript analysis needs neither engine. - **Requirements:** - The npm requirement is now its own line. - Added that static JavaScript needs only the Node/npm runtime. - **Current status:** - Added the "native binaries" bullet: Mach-O/ELF/PE/`.app`, IDA read-only function and string operations, and Hopper `.hop`. - Kept the 25 read-only Ghidra operations on Linux x64, macOS, and Windows P0. - Spelled out the Windows P0 target boundary. - `rea capabilities` / `rea providers` scope now mentions `binary_session` tool availability. - **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 local MCP registration for IDA. - Added the Windows P0 native controls and the macOS Accessibility/Screen Recording note. - **Uninstall:** only REA-owned MCP registrations and the managed skill are removed; Hopper, Node.js, Evidence, and other servers are preserved; and `--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. - **How it works:** shared workflows and Evidence contracts; providers declare capabilities and side effects; MCP sessions keep the active target and Evidence ledger. - **Roadmap:** replaced the old list, which presented already-shipped reconstruction checks as future work, with the English Now/Next/Later summary. It now notes IDA support already ships. - **Static JavaScript first result:** now says what the command returns and that `doctor` is not a per-analysis prerequisite. - **Tool catalog row text:** added Android/Apple inventory projections and "들어오는 정적 참조" (incoming static references). ### Prose improvements - **Terminology:** - provider is always 제공자 (공급자 removed; 공급업체 kept only for vendor). - Also unified 의존성, 에셋, 인벤토리, and 내 제품. - Evidence stays as the product term. - Consistent 합니다체, plus fixes to spacing and particles (for example `ASAR라면` became `ASAR 파일은`). - Rewrote literal sentences, for example `REA는 분석을 바이너리 증거에 근거하게 합니다` and the setup-selection paragraph. ### Not included These English sections are still absent from the condensed translation and can be added in follow-up PRs if wanted: - Readiness scopes, Linux install details, and the Ghidra and IDA Pro sections. - CLI or agent?, Showcase, and website/CDP/browser-scenario/V8 Inspector. - Choosing a provider, CLI exit status, and Process Capture. ## Contract and boundary impact - Semantic owner and earliest changed stage: documentation only (`README_ko.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. - User-visible CLI/MCP output: not applicable - Remaining proof gaps: **no fluent native-speaker review yet.** A Korean 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 - `npx oxfmt --check README_ko.md`: formatted - A local link check over every relative link and in-page anchor in `README_ko.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:54 +00:00

closed this issue
added the
pull-request
label

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

No description provided.

Rows
Columns