morluto/rea

Fork 0

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

[PR #1021] [CLOSED] docs(readme): polish the Arabic README and sync it with English #2587

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

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

📝 Commits (1)

b4d8c84 docs(readme): polish the Arabic README and sync it with English

📊 Changes

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

View changed files

📝 README_ar.md (+74 -70)

📄 Description

Summary

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

This PR polishes README_ar.md, corrects the places where it disagreed with the current English README and the source docs, and improves bidirectional rendering around commands and identifiers. It keeps the existing structure; this is a review and sync, not a re-translation.

Problem and expected behavior

The Arabic README contained outdated or incorrect technical statements and a few mistranslations. It also had mixed terminology and some Latin identifiers embedded in Arabic prose without code formatting, which can reorder under RTL rendering. Expected: clear Modern Standard Arabic that agrees with README.md, with commands and identifiers rendered LTR.

Change and scope

Technical corrections

Tagline: now matches "See a feature you like. Understand how it works, down to the binary level."
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.
Android verification platform: "ويغطي التحقق بالموفر الحقيقي نظام Linux" was incorrect. It now says the APK inspection supports Linux and macOS, and that the metadata bridge is verified on macOS arm64 with headless JADX.
Setup: it registers REA and installs matching workflow instructions, and adds MCP access and the guided workflow.
Requirements:
- The npm requirement is now its own line.
- "64-bit" was mistranslated as "بنواة 64 بت" ("with a 64-bit kernel"). It now reads "بإصدار 64 بت" or "بمعمارية 64 بت".
Windows P0 controls: "bundled" was attached to the paths only. It now applies to Job Object, DACL, and path-admission controls.
Ghidra on macOS: the Ghidra installation itself must include the native decompiler.
Uninstall: only REA-owned MCP registrations and the managed skill are removed, the preserved items are listed, and --purge-data affects only ~/.rea/cache and ~/.rea/state.
Current status:
- Added the "native binaries" bullet (Mach-O/ELF/PE/.app, IDA read-only operations, Hopper .hop).
- The rea capabilities / rea providers scope now mentions binary_session availability.
Ghidra scope:
- The 25 read-only operations apply on Linux, macOS, and Windows P0.
- Linux/macOS adds atomic name and entry-comment edits.
- Windows P0 is read-only.
- The FAQ no longer calls all Ghidra analysis read-only.
Mermaid diagram:
- The Ghidra node now includes annotations.
- Added the IDA MCP node.
Security: authenticated private sockets for Hopper and Ghidra, the IDA MCP registration, and the model provider's data policy. The Ghidra session now analyzes a temporary target copy in a temporary project.
Mistranslations fixed:
- Electron row: "نتائج الثبات والتشغيل" ("stability") became static/runtime analysis.
- FAQ: "يدعم وقت التشغيل … .hop" ("runtime") became the Hopper provider accepting .hop databases.
- The example prompt now matches the English one.
Smaller syncs:
- Static JavaScript first result: what it returns, and doctor is not a prerequisite.
- Hopper background-start caveat and cleanup_incomplete.
- Linux "install missing packages and rerun rea setup".
- IDA note in the roadmap.
- docs/testing.md link under Development.

Prose improvements

Terminology:
- provider is always مزوّد.
- agent is always وكيل (عميل removed).
- Setup as the actor is أداة الإعداد.
- Also unified السلاسل النصية, لقطات الشاشة, and النصوص البرمجية.
Spelling: consistent ـيًا endings, and shadda on ثبّت/يثبّت.
Punctuation: Arabic punctuation (، ؛) between clauses.
Bidirectional text: paths, commands, and identifiers inside Arabic sentences (~/.rea/cache, doctor, binary_session, close_binary, cleanup_incomplete) are now inline code. Bare parentheses next to Latin text were avoided.

Not included

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

Readiness scopes, the Ghidra and IDA Pro sections, and CLI or agent?
Showcase, website/CDP/browser-scenario/V8 Inspector, and CLI exit status.
Process Capture, manual MCP pinning notes, and some FAQ entries.

Contract and boundary impact

Semantic owner and earliest changed stage: documentation only (README_ar.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, and RTL rendering has not been checked in GitHub's preview. An Arabic 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_ar.md: formatted
A local link check over every relative link and in-page anchor in README_ar.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/1021 **Author:** [@akram1089](https://github.com/akram1089) **Created:** 10/7/2026 **Status:** ❌ Closed **Base:** `main` ← **Head:** `docs/958-readme-ar` --- ### 📝 Commits (1) - [`b4d8c84`](https://github.com/morluto/rea/commit/b4d8c841e48ce4dc4af9417cb7002e636e5af5f9) docs(readme): polish the Arabic README and sync it with English ### 📊 Changes **1 file changed** (+74 additions, -70 deletions) <details> <summary>View changed files</summary> 📝 `README_ar.md` (+74 -70) </details> ### 📄 Description ## Summary Refs #958 (Arabic item). This is one of four per-language PRs, so each language can be reviewed and merged on its own. This PR polishes `README_ar.md`, corrects the places where it disagreed with the current English README and the source docs, and improves bidirectional rendering around commands and identifiers. It keeps the existing structure; this is a review and sync, not a re-translation. ## Problem and expected behavior The Arabic README contained outdated or incorrect technical statements and a few mistranslations. It also had mixed terminology and some Latin identifiers embedded in Arabic prose without code formatting, which can reorder under RTL rendering. Expected: clear Modern Standard Arabic that agrees with `README.md`, with commands and identifiers rendered LTR. ## Change and scope ### Technical corrections - **Tagline:** now matches "See a feature you like. Understand how it works, down to the binary level." - **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. - **Android verification platform:** "ويغطي التحقق بالموفر الحقيقي نظام Linux" was incorrect. It now says the APK inspection supports Linux and macOS, and that the metadata bridge is verified on macOS arm64 with headless JADX. - **Setup:** it registers REA and installs matching workflow instructions, and adds MCP access and the guided workflow. - **Requirements:** - The npm requirement is now its own line. - "64-bit" was mistranslated as "بنواة 64 بت" ("with a 64-bit kernel"). It now reads "بإصدار 64 بت" or "بمعمارية 64 بت". - **Windows P0 controls:** "bundled" was attached to the paths only. It now applies to Job Object, DACL, and path-admission controls. - **Ghidra on macOS:** the Ghidra installation itself must include the native decompiler. - **Uninstall:** only REA-owned MCP registrations and the managed skill are removed, the preserved items are listed, and `--purge-data` affects only `~/.rea/cache` and `~/.rea/state`. - **Current status:** - Added the "native binaries" bullet (Mach-O/ELF/PE/`.app`, IDA read-only operations, Hopper `.hop`). - The `rea capabilities` / `rea providers` scope now mentions `binary_session` availability. - **Ghidra scope:** - The 25 read-only operations apply on Linux, macOS, and Windows P0. - Linux/macOS adds atomic name and entry-comment edits. - Windows P0 is read-only. - The FAQ no longer calls all Ghidra analysis read-only. - **Mermaid diagram:** - The Ghidra node now includes annotations. - Added the IDA MCP node. - **Security:** authenticated private sockets for Hopper and Ghidra, the IDA MCP registration, and the model provider's data policy. The Ghidra session now analyzes a temporary target copy in a temporary project. - **Mistranslations fixed:** - Electron row: "نتائج الثبات والتشغيل" ("stability") became static/runtime analysis. - FAQ: "يدعم وقت التشغيل … `.hop`" ("runtime") became the Hopper provider accepting `.hop` databases. - The example prompt now matches the English one. - **Smaller syncs:** - Static JavaScript first result: what it returns, and `doctor` is not a prerequisite. - Hopper background-start caveat and `cleanup_incomplete`. - Linux "install missing packages and rerun `rea setup`". - IDA note in the roadmap. - `docs/testing.md` link under Development. ### Prose improvements - **Terminology:** - provider is always مزوّد. - agent is always وكيل (عميل removed). - Setup as the actor is أداة الإعداد. - Also unified السلاسل النصية, لقطات الشاشة, and النصوص البرمجية. - **Spelling:** consistent ـيًا endings, and shadda on ثبّت/يثبّت. - **Punctuation:** Arabic punctuation (، ؛) between clauses. - **Bidirectional text:** paths, commands, and identifiers inside Arabic sentences (`~/.rea/cache`, `doctor`, `binary_session`, `close_binary`, `cleanup_incomplete`) are now inline code. Bare parentheses next to Latin text were avoided. ### Not included These English sections are still absent from the condensed translation and can be added in follow-up PRs if wanted: - Readiness scopes, the Ghidra and IDA Pro sections, and CLI or agent? - Showcase, website/CDP/browser-scenario/V8 Inspector, and CLI exit status. - Process Capture, manual MCP pinning notes, and some FAQ entries. ## Contract and boundary impact - Semantic owner and earliest changed stage: documentation only (`README_ar.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**, and RTL rendering has not been checked in GitHub's preview. An Arabic 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_ar.md`: formatted - A local link check over every relative link and in-page anchor in `README_ar.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

bsakaguchi referenced this issue

2026-10-31 01:07:13 +00:00

[PR #2949] [CLOSED] fix(verify): resolve Hopper dispatcher as a filesystem path #5513

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

No description provided.

Rows
Columns