morluto/rea

Fork 0

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

[PR #1019] [CLOSED] docs(readme): polish the Japanese README and sync it with English #2586

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/1019
Author: @akram1089
Created: 10/7/2026
Status: ❌ Closed

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

📝 Commits (1)

b432823 docs(readme): polish the Japanese README and sync it with English

📊 Changes

1 file changed (+35 additions, -30 deletions)

View changed files

📝 README_ja.md (+35 -30)

📄 Description

Summary

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

This PR polishes README_ja.md and fills in technical details where it had fallen behind the current English README. It keeps the existing structure; this is a review and sync, not a re-translation.

Problem and expected behavior

The Japanese README was the most complete translation, but several sections lagged behind English: doctor scopes, provider selection, IDA modes, update and pinning, roadmap, and Hopper caching. Some wording was also literal. Expected: natural です・ます prose that agrees with README.md.

Change and scope

Technical corrections

Header nav: the "DX-Ball の事例" link now points to the Showcases index (/showcase/), as the English nav does.
Scoped doctor report: added scope.mode: "explicit", that environment_healthy still summarizes the full audit, and that --target without a scope option stays audit-wide (English "Check readiness").
Multiple installed engines:
- An explicit selector overrides REA_ANALYSIS_PROVIDER.
- The session never falls back to another engine.
- Recovery depends on ambiguous versus provider_unavailable (rea doctor --provider <id> --json).
- Neither case means installing every engine.
Ghidra:
- Added rea providers --json to the setup block, matching English.
- Setup saves paths into the selected agents' configuration after approval.
- Ghidra and Java must already be installed.
- The macOS decompiler must be part of the Ghidra installation.
IDA:
- attached uses the legacy 1.4 tools and headless uses the modern database supervisor.
- An attached database is left open and never saved.
- Other engine/platform combinations remain unverified.
Uninstall: it refuses malformed client configuration, and --purge-data removes only ~/.rea/cache and ~/.rea/state without following symlinks.
Current status: added the English opening sentence on macOS/Linux scope and per-tool prerequisites.
Roadmap:
- Next now includes connecting managed findings to verified native analysis.
- Later now includes actions beyond click and wait, and the list of tools to evaluate.
- IDA already ships.
Manual MCP pinning: added the Codex 30-second startup allowance and the rea update behavior (exact release, verification, maintenance plan, restart).
How it works: providers declare capabilities and their side effects.
Hopper:
- Successful decompilation is cached until a relevant rename or comment change.
- Added the rea instructions tip.
- Closing a session stops the bridge rather than "deleting" it.
Smaller syncs:
- The --help sentence now mentions bounded search.
- Added the steps-table intro sentence.
- The npm requirement wording now matches English.

Prose improvements

Terminology:
- 完全な JDK became フル JDK.
- 制限 became 制限事項 for result limitations.
- Evidence の契約 became Evidence コントラクト.
- ローカルホスト became ローカルマシン, to avoid confusion with "localhost".
- The catalog column 用途 became 例, matching "Examples".
Smoothed literal sentences, for example 「元のソースコードを復元できる、あるいは…とは主張しません」 and 「オプションなしの rea doctor は連携全体の監査です」.

Not included

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

Linux install details, Firmware/Apple paragraphs, and Ghidra deadlines/DOS/NativeAOT.
CLI or agent?, Showcase, and website/CDP/browser-scenario/V8 Inspector.
CLI exit status, Process Capture, and some FAQ entries.

Contract and boundary impact

Semantic owner and earliest changed stage: documentation only (README_ja.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.
User-visible CLI/MCP output: not applicable
Remaining proof gaps: no fluent native-speaker review yet. A Japanese 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_ja.md: formatted
A local link check over every relative link and in-page anchor in README_ja.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/1019 **Author:** [@akram1089](https://github.com/akram1089) **Created:** 10/7/2026 **Status:** ❌ Closed **Base:** `main` ← **Head:** `docs/958-readme-ja` --- ### 📝 Commits (1) - [`b432823`](https://github.com/morluto/rea/commit/b43282313e1643e6667859f62382a3d47b1a47dc) docs(readme): polish the Japanese README and sync it with English ### 📊 Changes **1 file changed** (+35 additions, -30 deletions) <details> <summary>View changed files</summary> 📝 `README_ja.md` (+35 -30) </details> ### 📄 Description ## Summary Refs #958 (Japanese item). This is one of four per-language PRs, so each language can be reviewed and merged on its own. This PR polishes `README_ja.md` and fills in technical details where it had fallen behind the current English README. It keeps the existing structure; this is a review and sync, not a re-translation. ## Problem and expected behavior The Japanese README was the most complete translation, but several sections lagged behind English: doctor scopes, provider selection, IDA modes, update and pinning, roadmap, and Hopper caching. Some wording was also literal. Expected: natural です・ます prose that agrees with `README.md`. ## Change and scope ### Technical corrections - **Header nav:** the "DX-Ball の事例" link now points to the Showcases index (`/showcase/`), as the English nav does. - **Scoped doctor report:** added `scope.mode: "explicit"`, that `environment_healthy` still summarizes the full audit, and that `--target` without a scope option stays audit-wide (English "Check readiness"). - **Multiple installed engines:** - An explicit selector overrides `REA_ANALYSIS_PROVIDER`. - The session never falls back to another engine. - Recovery depends on `ambiguous` versus `provider_unavailable` (`rea doctor --provider <id> --json`). - Neither case means installing every engine. - **Ghidra:** - Added `rea providers --json` to the setup block, matching English. - Setup saves paths into the selected agents' configuration after approval. - Ghidra and Java must already be installed. - The macOS decompiler must be part of the Ghidra installation. - **IDA:** - `attached` uses the legacy 1.4 tools and `headless` uses the modern database supervisor. - An attached database is left open and never saved. - Other engine/platform combinations remain unverified. - **Uninstall:** it refuses malformed client configuration, and `--purge-data` removes only `~/.rea/cache` and `~/.rea/state` without following symlinks. - **Current status:** added the English opening sentence on macOS/Linux scope and per-tool prerequisites. - **Roadmap:** - Next now includes connecting managed findings to verified native analysis. - Later now includes actions beyond click and wait, and the list of tools to evaluate. - IDA already ships. - **Manual MCP pinning:** added the Codex 30-second startup allowance and the `rea update` behavior (exact release, verification, maintenance plan, restart). - **How it works:** providers declare capabilities and their side effects. - **Hopper:** - Successful decompilation is cached until a relevant rename or comment change. - Added the `rea instructions` tip. - Closing a session stops the bridge rather than "deleting" it. - **Smaller syncs:** - The `--help` sentence now mentions bounded search. - Added the steps-table intro sentence. - The npm requirement wording now matches English. ### Prose improvements - **Terminology:** - 完全な JDK became フル JDK. - 制限 became 制限事項 for result limitations. - Evidence の契約 became Evidence コントラクト. - ローカルホスト became ローカルマシン, to avoid confusion with "localhost". - The catalog column 用途 became 例, matching "Examples". - Smoothed literal sentences, for example 「元のソースコードを復元できる、あるいは…とは主張しません」 and 「オプションなしの `rea doctor` は連携全体の監査です」. ### Not included These English sections are still absent from the translation and can be added in follow-up PRs if wanted: - Linux install details, Firmware/Apple paragraphs, and Ghidra deadlines/DOS/NativeAOT. - CLI or agent?, Showcase, and website/CDP/browser-scenario/V8 Inspector. - CLI exit status, Process Capture, and some FAQ entries. ## Contract and boundary impact - Semantic owner and earliest changed stage: documentation only (`README_ja.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`. - User-visible CLI/MCP output: not applicable - Remaining proof gaps: **no fluent native-speaker review yet.** A Japanese 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_ja.md`: formatted - A local link check over every relative link and in-page anchor in `README_ja.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#2586

No description provided.

Rows
Columns