[PR #4566] [CLOSED] docs(i18n): add the Linux procps prerequisite to translated READMEs #6313

Closed
opened 2026-10-31 01:13:29 +00:00 by bsakaguchi · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/4566
Author: @himanshug9119
Created: 10/16/2026
Status: ❌ Closed

Base: main ← Head: docs/readme-procps-prerequisite


📝 Commits (4)

  • 7d3f25a docs(i18n): add the Linux procps prerequisite to translated READMEs
  • e999bf8 Merge branch 'main' into docs/readme-procps-prerequisite
  • e35d9e7 Restore source files changed by the pre-commit lint fix during the merge
  • 5ac6987 Merge branch 'main' into docs/readme-procps-prerequisite

📊 Changes

17 files changed (+51 additions, -17 deletions)

View changed files

📝 docs/readme/README_de.md (+3 -1)
📝 docs/readme/README_el.md (+3 -1)
📝 docs/readme/README_es.md (+3 -1)
📝 docs/readme/README_fa.md (+3 -1)
📝 docs/readme/README_fr.md (+3 -1)
📝 docs/readme/README_id.md (+3 -1)
📝 docs/readme/README_it.md (+3 -1)
📝 docs/readme/README_ja.md (+3 -1)
📝 docs/readme/README_pl.md (+3 -1)
📝 docs/readme/README_pt-BR.md (+3 -1)
📝 docs/readme/README_ru.md (+3 -1)
📝 docs/readme/README_th.md (+3 -1)
📝 docs/readme/README_tr.md (+3 -1)
📝 docs/readme/README_uk.md (+3 -1)
📝 docs/readme/README_vi.md (+3 -1)
📝 docs/readme/README_zh-TW.md (+3 -1)
📝 docs/readme/README_zh.md (+3 -1)

📄 Description

Summary

Refs #4564

The English README tells Linux users that Ghidra, JADX, firmware tool launches and static JavaScript/Electron analysis need a procps-compatible ps on REA's PATH. Only the Korean translation carried this, so readers of the other editions were not told about the prerequisite or where its recovery steps live.

Problem and expected behavior

A Linux user following a translated Quick start isn't told about the procps requirement. Expected: every edition states it in Quick start and in the JavaScript / Electron requirements cell, as README.md does.

Change and scope

  • Add the Quick start paragraph (README.md "Quick start", first paragraph) to 17 translated READMEs, translated in place. The docs/installation.md path and the "Linux owned-process prerequisite" section name stay in English so readers can find them.
  • Add Linux: procps-compatible ps to each edition's JavaScript / Electron requirements cell, using that edition's existing separator.
  • Not included: README_ko.md (already has both) and README_ar.md (left to #4139). The Go, SQLite and Bun gaps from the same issue are in a separate PR.

Contribution scope: documentation only, within existing boundaries; no maintainer scope decision needed.

Contract and boundary impact

  • Semantic owner and earliest changed stage: docs/readme/README_*.md translations of README.md

  • Contribution scope fit and linked maintainer decision: documentation fix; not applicable

  • CLI and MCP/tool-catalog contract: none

  • Provider, bridge, target-format, or platform compatibility: none

  • Evidence, artifact, provenance, or reconstruction contract: none

  • Target selection, authority, upstream behavior, and cleanup details (if applicable): not applicable

  • Generated metadata, package, or installation impact: none

  • Documentation or usability only; no target interaction.

Evidence and regression coverage

  • Tests added or updated: none (prose and table cells are not covered by readmeConsistency.test.ts)
  • Base reproduction or other evidence: on main (8116dc0), grep -L procps docs/readme/README_*.md lists 18 editions; on this branch it lists only README_ar.md.
  • Remaining proof gaps: translations are AI-assisted. Placement, formatting and preserved commands were checked, but not native-speaker fluency. Corrections from native speakers are welcome.

Validation performed

  • npx oxfmt --check docs/readme/ README.md: all files use the correct format
  • npm run test:local -- tests/conformance/readmeConsistency.test.ts: 5/5 passed
  • npm run docs:check: passed (exit 0)

Compatibility, safety, and release

  • Breaking changes or migration steps: none
  • Real Hopper/Ghidra, browser, or OS coverage: not applicable (documentation only)
  • Package or release metadata impact: none
  • Security, privacy, process, or containment review: not applicable

Author readiness

Human owner: @himanshug9119

  • I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work.
  • I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps.
  • I declare this PR ready for initial maintainer review.

Before merge

  • This PR addresses a concrete problem or an agreed enhancement.
  • Material scope and authority questions are resolved, and any required maintainer scope decision covers the final diff.
  • 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/4566 **Author:** [@himanshug9119](https://github.com/himanshug9119) **Created:** 10/16/2026 **Status:** ❌ Closed **Base:** `main` ← **Head:** `docs/readme-procps-prerequisite` --- ### 📝 Commits (4) - [`7d3f25a`](https://github.com/morluto/rea/commit/7d3f25a16ee705e068f69314a890a2c3ac36d371) docs(i18n): add the Linux procps prerequisite to translated READMEs - [`e999bf8`](https://github.com/morluto/rea/commit/e999bf85bd24e1c1f168f04a2ca6cb1219a236e5) Merge branch 'main' into docs/readme-procps-prerequisite - [`e35d9e7`](https://github.com/morluto/rea/commit/e35d9e74c640a5a0e016e5833c60a6683f00bad6) Restore source files changed by the pre-commit lint fix during the merge - [`5ac6987`](https://github.com/morluto/rea/commit/5ac6987b3ff9b708078aed09a810d79d3fd050e0) Merge branch 'main' into docs/readme-procps-prerequisite ### 📊 Changes **17 files changed** (+51 additions, -17 deletions) <details> <summary>View changed files</summary> 📝 `docs/readme/README_de.md` (+3 -1) 📝 `docs/readme/README_el.md` (+3 -1) 📝 `docs/readme/README_es.md` (+3 -1) 📝 `docs/readme/README_fa.md` (+3 -1) 📝 `docs/readme/README_fr.md` (+3 -1) 📝 `docs/readme/README_id.md` (+3 -1) 📝 `docs/readme/README_it.md` (+3 -1) 📝 `docs/readme/README_ja.md` (+3 -1) 📝 `docs/readme/README_pl.md` (+3 -1) 📝 `docs/readme/README_pt-BR.md` (+3 -1) 📝 `docs/readme/README_ru.md` (+3 -1) 📝 `docs/readme/README_th.md` (+3 -1) 📝 `docs/readme/README_tr.md` (+3 -1) 📝 `docs/readme/README_uk.md` (+3 -1) 📝 `docs/readme/README_vi.md` (+3 -1) 📝 `docs/readme/README_zh-TW.md` (+3 -1) 📝 `docs/readme/README_zh.md` (+3 -1) </details> ### 📄 Description ## Summary Refs #4564 The English README tells Linux users that Ghidra, JADX, firmware tool launches and static JavaScript/Electron analysis need a procps-compatible `ps` on REA's `PATH`. Only the Korean translation carried this, so readers of the other editions were not told about the prerequisite or where its recovery steps live. ## Problem and expected behavior A Linux user following a translated Quick start isn't told about the procps requirement. Expected: every edition states it in Quick start and in the JavaScript / Electron requirements cell, as `README.md` does. ## Change and scope - Add the Quick start paragraph (README.md "Quick start", first paragraph) to 17 translated READMEs, translated in place. The `docs/installation.md` path and the "Linux owned-process prerequisite" section name stay in English so readers can find them. - Add `Linux: procps-compatible ps` to each edition's JavaScript / Electron requirements cell, using that edition's existing separator. - Not included: `README_ko.md` (already has both) and `README_ar.md` (left to #4139). The Go, SQLite and Bun gaps from the same issue are in a separate PR. Contribution scope: documentation only, within existing boundaries; no maintainer scope decision needed. ## Contract and boundary impact - Semantic owner and earliest changed stage: `docs/readme/README_*.md` translations of `README.md` - Contribution scope fit and linked maintainer decision: documentation fix; not applicable - CLI and MCP/tool-catalog contract: none - Provider, bridge, target-format, or platform compatibility: none - Evidence, artifact, provenance, or reconstruction contract: none - Target selection, authority, upstream behavior, and cleanup details (if applicable): not applicable - Generated metadata, package, or installation impact: none - [x] Documentation or usability only; no target interaction. ## Evidence and regression coverage - Tests added or updated: none (prose and table cells are not covered by `readmeConsistency.test.ts`) - Base reproduction or other evidence: on `main` (8116dc0), `grep -L procps docs/readme/README_*.md` lists 18 editions; on this branch it lists only `README_ar.md`. - Remaining proof gaps: translations are AI-assisted. Placement, formatting and preserved commands were checked, but not native-speaker fluency. Corrections from native speakers are welcome. ## Validation performed - `npx oxfmt --check docs/readme/ README.md`: all files use the correct format - `npm run test:local -- tests/conformance/readmeConsistency.test.ts`: 5/5 passed - `npm run docs:check`: passed (exit 0) ## Compatibility, safety, and release - Breaking changes or migration steps: none - Real Hopper/Ghidra, browser, or OS coverage: not applicable (documentation only) - Package or release metadata impact: none - Security, privacy, process, or containment review: not applicable ## Author readiness Human owner: @himanshug9119 - [x] I reviewed the final diff and relevant existing code, understand the change and its edge cases, and take responsibility for the complete PR, including AI-assisted work. - [x] I checked the evidence above, confirmed it supports the current change, and recorded meaningful validation gaps. - [x] I declare this PR ready for initial maintainer review. ## Before merge - [x] This PR addresses a concrete problem or an agreed enhancement. - [x] Material scope and authority questions are resolved, and any required maintainer scope decision covers the final diff. - [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. - [ ] Tests cover changed observable behavior and meaningful failure paths. - [x] Owning docs, contracts, and generated metadata are updated where needed. - [ ] 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-31 01:13:29 +00:00
Sign in to join this conversation.
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#6313
No description provided.