[PR #996] [MERGED] docs: polish the Japanese README and align it with current facts #2565

New issue

Closed

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

bsakaguchi commented

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

Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/996
Author: @kaoru0822-kitauji
Created: 10/7/2026
Status: ✅ Merged
Merged: 10/7/2026
Merged by: @kaoru0822-kitauji

Base: main ← Head: docs/ja-readme-polish

📝 Commits (1)

e45da24 docs: polish the Japanese README and align it with current facts

📊 Changes

1 file changed (+137 additions, -85 deletions)

View changed files

📝 README_ja.md (+137 -85)

📄 Description

Summary

Japanese portion of #958. Reviews README_ja.md as a whole against the current README.md and the provider guides, fixes technical drift, and polishes the prose. Commands, option names, environment variables, URLs, identifiers, badges, tool counts, and the release-please MCP block are unchanged.

Technical corrections

Area	Before	Now (matches `README.md` / guides)
Deep providers	Native analysis named only Hopper or Ghidra; IDA was absent everywhere	Hopper, Ghidra, or IDA Pro; adds the bring-your-own IDA adapter (attached/headless, never saves a GUI database, initial verification on Windows) with a link to `docs/ida-provider.md`
Architecture diagram	Ghidra labeled "read-only analysis"	Ghidra shows inventory + function analysis + annotations; IDA provider added
Android	"Real provider verification targets Linux"	Linux and macOS supported; current metadata bridge verified on macOS arm64; needs headless JADX and a full JDK (`docs/android-analysis.md`)
Security model	"capability token and Unix socket" per session	Authenticated private local sockets for Hopper/Ghidra and the configured local MCP registration for IDA; Windows P0 native controls
Uninstall	"removes registrations and workflow files"	Removes only REA-owned registrations and the managed skill; lists what is preserved; `--purge-data` removes only `~/.rea/cache` and `~/.rea/state`
Requirements	npm listed with Node	Separate npm line: no particular version required or installed
`rea capabilities`	Only `capabilities`	`capabilities` and `providers`, and points to `binary_session` tool availability
Tool catalog	Application workflows omitted Android/Apple inventory projections	Added (counts unchanged)
Roadmap	One-sentence summary from an older roadmap	Now / Next / Later summary of the current English roadmap

Added sections, following the English README

ターミナルで最初の結果を得る: the static JavaScript command moved out of the skill section. It now says the command needs no MCP, Hopper, or Ghidra and does not execute the app.
作業に合わせて準備状況を確認する: scoped rea doctor --provider/--client/--skill, scope_checks vs informational_checks, and the ambiguous provider-selection recovery. Unscoped healthy: false reports confused users in #832.
A Ghidra setup example, the IDA example, Hopper's one-request-at-a-time and cleanup_incomplete behavior, the Ghidra/Java FAQ, and the exact-version pin note under manual MCP configuration.

Prose improvements

Unified the mixed Setup / セットアップ subject to セットアップ in prose (the setup command is unchanged).
Rewrote literal translations, for example 構造を回収する → 構造を復元する, 初期選択 → 最初から選択, and 自分のブリッジセッション → 自身の.
Updated the tagline and subtitle to the current English meaning.
Clarified subjects in the introduction and the step-6 explanation.
Made the FAQ answers complete sentences.

Verification

npx vitest run tests/conformance/readmeConsistency.test.ts: 9 passed (requirements, client names, versioned MCP JSON, badge).
npm run docs:check: passed (includes check-doc-facts.mjs tool-family counts).
Script check of every relative link and in-page anchor in README_ja.md, including README.md#… and docs/…#… targets: 0 broken.

Outstanding language review

Japanese: written by an AI assistant and checked against the English source. A native-speaker review is still welcome.
Chinese, Korean, and Arabic READMEs are not changed here and remain open under #958.

Refs #958

🤖 Generated with Claude Code

_{🔄 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/996 **Author:** [@kaoru0822-kitauji](https://github.com/kaoru0822-kitauji) **Created:** 10/7/2026 **Status:** ✅ Merged **Merged:** 10/7/2026 **Merged by:** [@kaoru0822-kitauji](https://github.com/kaoru0822-kitauji) **Base:** `main` ← **Head:** `docs/ja-readme-polish` --- ### 📝 Commits (1) - [`e45da24`](https://github.com/morluto/rea/commit/e45da242971cdca5021e182691df08c9e91a44fa) docs: polish the Japanese README and align it with current facts ### 📊 Changes **1 file changed** (+137 additions, -85 deletions) <details> <summary>View changed files</summary> 📝 `README_ja.md` (+137 -85) </details> ### 📄 Description ## Summary Japanese portion of #958. Reviews `README_ja.md` as a whole against the current `README.md` and the provider guides, fixes technical drift, and polishes the prose. Commands, option names, environment variables, URLs, identifiers, badges, tool counts, and the release-please MCP block are unchanged. ## Technical corrections | Area | Before | Now (matches `README.md` / guides) | |---|---|---| | Deep providers | Native analysis named only Hopper or Ghidra; IDA was absent everywhere | Hopper, Ghidra, or IDA Pro; adds the bring-your-own IDA adapter (attached/headless, never saves a GUI database, initial verification on Windows) with a link to `docs/ida-provider.md` | | Architecture diagram | Ghidra labeled "read-only analysis" | Ghidra shows inventory + function analysis + annotations; IDA provider added | | Android | "Real provider verification targets Linux" | Linux and macOS supported; current metadata bridge verified on macOS arm64; needs headless JADX and a full JDK (`docs/android-analysis.md`) | | Security model | "capability token and Unix socket" per session | Authenticated private local sockets for Hopper/Ghidra and the configured local MCP registration for IDA; Windows P0 native controls | | Uninstall | "removes registrations and workflow files" | Removes only REA-owned registrations and the managed skill; lists what is preserved; `--purge-data` removes only `~/.rea/cache` and `~/.rea/state` | | Requirements | npm listed with Node | Separate npm line: no particular version required or installed | | `rea capabilities` | Only `capabilities` | `capabilities` and `providers`, and points to `binary_session` tool availability | | Tool catalog | Application workflows omitted Android/Apple inventory projections | Added (counts unchanged) | | Roadmap | One-sentence summary from an older roadmap | Now / Next / Later summary of the current English roadmap | ## Added sections, following the English README - **ターミナルで最初の結果を得る**: the static JavaScript command moved out of the skill section. It now says the command needs no MCP, Hopper, or Ghidra and does not execute the app. - **作業に合わせて準備状況を確認する**: scoped `rea doctor --provider/--client/--skill`, `scope_checks` vs `informational_checks`, and the `ambiguous` provider-selection recovery. Unscoped `healthy: false` reports confused users in #832. - A Ghidra setup example, the IDA example, Hopper's one-request-at-a-time and `cleanup_incomplete` behavior, the Ghidra/Java FAQ, and the exact-version pin note under manual MCP configuration. ## Prose improvements - Unified the mixed `Setup` / `セットアップ` subject to `セットアップ` in prose (the `setup` command is unchanged). - Rewrote literal translations, for example 構造を回収する → 構造を復元する, 初期選択 → 最初から選択, and 自分のブリッジセッション → 自身の. - Updated the tagline and subtitle to the current English meaning. - Clarified subjects in the introduction and the step-6 explanation. - Made the FAQ answers complete sentences. ## Verification - `npx vitest run tests/conformance/readmeConsistency.test.ts`: 9 passed (requirements, client names, versioned MCP JSON, badge). - `npm run docs:check`: passed (includes `check-doc-facts.mjs` tool-family counts). - Script check of every relative link and in-page anchor in `README_ja.md`, including `README.md#…` and `docs/…#…` targets: 0 broken. ## Outstanding language review - Japanese: written by an AI assistant and checked against the English source. A native-speaker review is still welcome. - Chinese, Korean, and Arabic READMEs are not changed here and remain open under #958. Refs #958 🤖 Generated with [Claude Code](https://claude.com/claude-code) --- <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:40 +00:00