[GH-ISSUE #4564] [Docs] Translated READMEs omit the Linux procps prerequisite, Go/SQLite rows and Bun update steps #2372

New issue

Closed

opened 2026-10-17 21:03:51 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-17 21:03:51 +00:00

Owner

Originally created by @himanshug9119 on GitHub (Oct 16, 2026).
Original GitHub issue: https://github.com/morluto/rea/issues/4564

Before submitting

I searched the existing issues for a related documentation report.
I removed credentials, tokens, private paths, and sensitive target data.

Documentation location

docs/readme/README_*.md (Quick start, "What you can analyze", "Update REA"), compared with README.md

Problem

Several facts in the English README.md are missing from most translated editions in docs/readme/:

English README fact	Translations missing it
Quick start: Linux requires a procps-compatible `ps` on REA's `PATH` (Ghidra, JADX, firmware, static JavaScript/Electron)	ar, de, el, es, fa, fr, id, it, ja, pl, pt-BR, ru, th, tr, uk, vi, zh-TW, zh (all except ko)
"What you can analyze": SQLite databases row	ar, de, es, fa, fr, id, it, ja, pl, pt-BR, ru, th, uk, vi, zh-TW, zh
"What you can analyze": Go binaries row	ar, de, es, fa, fr, id, it, ja, pl, pt-BR, ru, th, uk, vi
Update REA: `bun add --global` installs and the Bun 1.2.17 requirement for `rea update`	ar, de, es, fa, ja, pl, pt-BR, ru, th, uk, vi

The procps gap has the most impact: a Linux user following a translated Quick start isn't told about a prerequisite that Ghidra, JADX, firmware and static JavaScript/Electron launches depend on, and the recovery steps (docs/installation.md, "Linux owned-process prerequisite") aren't linked.

tests/conformance/readmeConsistency.test.ts keeps translated bash examples aligned with English but doesn't cover prose or table rows, so this drift passes CI.

Expected content

Each translated README carries the same facts as README.md for these sections, translated in place:

The Linux procps paragraph at the start of Quick start (README.md lines 71-74; the Korean edition already includes it at docs/readme/README_ko.md line 69).
The "Go binaries" and "SQLite databases" rows in the "What you can analyze" table.
The Bun install/update wording in "Update REA".

Proposed: I plan to send two focused PRs, one for (1) and one for (2)+(3). I'll leave README_ar.md out to avoid overlapping with #4139, which is already synchronizing the Arabic edition.

Supporting evidence

Reproduce from a checkout of main at 8116dc0:

for fact in 'procps' '^\|[^|]*\bGo\b' 'SQLite' 'bun add --global'; do
  printf '%-22s missing in:' "$fact"
  for f in docs/readme/README_*.md; do
    grep -Eq -- "$fact" "$f" || printf ' %s' "$(basename "$f" .md | sed 's/README_//')"
  done
  echo
done

The source passages are README.md "Quick start" (procps), the "What you can analyze" table rows "Go binaries" and "SQLite databases", and "Update REA" (Bun).

Additional context

Related: #4139 (Arabic README sync). The check above is text-based, so I confirmed matches by hand; e.g. the Greek and Turkish Go rows use translated labels ("Δυαδικά αρχεία Go", "Go ikili dosyaları") and are counted as present.

Originally created by @himanshug9119 on GitHub (Oct 16, 2026). Original GitHub issue: https://github.com/morluto/rea/issues/4564 ### Before submitting - [x] I searched the existing issues for a related documentation report. - [x] I removed credentials, tokens, private paths, and sensitive target data. ### Documentation location docs/readme/README_*.md (Quick start, "What you can analyze", "Update REA"), compared with README.md ### Problem Several facts in the English README.md are missing from most translated editions in docs/readme/: | English README fact | Translations missing it | |---|---| | Quick start: Linux requires a procps-compatible `ps` on REA's `PATH` (Ghidra, JADX, firmware, static JavaScript/Electron) | ar, de, el, es, fa, fr, id, it, ja, pl, pt-BR, ru, th, tr, uk, vi, zh-TW, zh (all except ko) | | "What you can analyze": SQLite databases row | ar, de, es, fa, fr, id, it, ja, pl, pt-BR, ru, th, uk, vi, zh-TW, zh | | "What you can analyze": Go binaries row | ar, de, es, fa, fr, id, it, ja, pl, pt-BR, ru, th, uk, vi | | Update REA: `bun add --global` installs and the Bun 1.2.17 requirement for `rea update` | ar, de, es, fa, ja, pl, pt-BR, ru, th, uk, vi | The procps gap has the most impact: a Linux user following a translated Quick start isn't told about a prerequisite that Ghidra, JADX, firmware and static JavaScript/Electron launches depend on, and the recovery steps (docs/installation.md, "Linux owned-process prerequisite") aren't linked. `tests/conformance/readmeConsistency.test.ts` keeps translated `bash` examples aligned with English but doesn't cover prose or table rows, so this drift passes CI. ### Expected content Each translated README carries the same facts as README.md for these sections, translated in place: 1. The Linux procps paragraph at the start of Quick start (README.md lines 71-74; the Korean edition already includes it at docs/readme/README_ko.md line 69). 2. The "Go binaries" and "SQLite databases" rows in the "What you can analyze" table. 3. The Bun install/update wording in "Update REA". Proposed: I plan to send two focused PRs, one for (1) and one for (2)+(3). I'll leave README_ar.md out to avoid overlapping with #4139, which is already synchronizing the Arabic edition. ### Supporting evidence Reproduce from a checkout of main at 8116dc0: ```bash for fact in 'procps' '^\|[^|]*\bGo\b' 'SQLite' 'bun add --global'; do printf '%-22s missing in:' "$fact" for f in docs/readme/README_*.md; do grep -Eq -- "$fact" "$f" || printf ' %s' "$(basename "$f" .md | sed 's/README_//')" done echo done ``` The source passages are README.md "Quick start" (procps), the "What you can analyze" table rows "Go binaries" and "SQLite databases", and "Update REA" (Bun). ### Additional context Related: #4139 (Arabic README sync). The check above is text-based, so I confirmed matches by hand; e.g. the Greek and Turkish Go rows use translated labels ("Δυαδικά αρχεία Go", "Go ikili dosyaları") and are counted as present.

bsakaguchi added the

triage

documentation

labels

2026-10-17 21:03:51 +00:00

bsakaguchi referenced this issue

2026-10-31 00:29:41 +00:00

[GH-ISSUE #2383] [Tracker] Audit analysis and debugging coverage for the TIOBE top 100 languages (October 2026) #794

bsakaguchi closed this issue

2026-10-31 00:33:11 +00:00

bsakaguchi referenced this issue

2026-10-31 01:04:46 +00:00