[PR #1355] [CLOSED] docs: clarify README setup command, mention IDA, and update Node badge #2821

New issue

Closed

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

bsakaguchi commented

2026-10-17 21:10:41 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/1355
Author: @akram1089
Created: 10/9/2026
Status: ❌ Closed

Base: main ← Head: docs/readme-fixes

📝 Commits (1)

b08690c docs: clarify README setup command, mention IDA, and update Node badge

📊 Changes

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

View changed files

📝 README.md (+4 -4)
📝 README_ar.md (+2 -2)
📝 README_de.md (+2 -2)
📝 README_es.md (+2 -2)
📝 README_fa.md (+2 -2)
📝 README_fr.md (+2 -2)
📝 README_ja.md (+2 -2)
📝 README_ko.md (+2 -2)
📝 README_pl.md (+2 -2)
📝 README_pt-BR.md (+2 -2)
📝 README_ru.md (+2 -2)
📝 README_th.md (+2 -2)
📝 README_tr.md (+2 -2)
📝 README_uk.md (+2 -2)
📝 README_vi.md (+2 -2)
📝 README_zh-TW.md (+2 -2)
📝 README_zh.md (+2 -2)

📄 Description

Summary

Fixes #1353.

Addresses documentation issues reported in the README and translated READMEs:

Replaces rea setup with npx rea-agents setup in the skills.sh FAQ across README.md and all 16 translated READMEs so users who only installed the skill can run setup without needing a prior global npm installation.
Mentions IDA alongside Hopper and Ghidra in the intro section of README.md.
Clarifies the supported Node.js version badge (Node.js 22.19+ · 24.11+ · 26+) and links to the #what-you-can-analyze section across all READMEs.
Updates the .NET assemblies requirement row in the table to "None (static only)".

Problem and expected behavior

In the skills.sh FAQ, rea setup assumed a global install of rea-agents, which fails for users who only installed the skill from skills.sh.
The intro mentioned native analysis with Hopper or Ghidra, leaving out supported IDA analysis.
The Node.js badge displayed 22+, whereas Node 23, 24.0-24.10, and 25 are unsupported.
The .NET assemblies row stated "Static inspection" as a requirement rather than "None (static only)".

Change and scope

Updated README.md and 16 translated README_*.md files.
Kept link targets consistent with scripts/lib/docs-facts.mjs.

Contract and boundary impact

Semantic owner and earliest changed stage: documentation
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, package, or installation impact: verified with npm run docs:check

Evidence and regression coverage

Documentation facts check: npm run docs:check runs docs-facts.mjs verifying link and text parity across all READMEs.

Validation performed

npm run docs:check: passed (all 6 tasks successful, no doc drift)
npm run check:fast: passed (typecheck & lint clean)
npx oxfmt: passed

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: Local documentation change only

Review checklist

This PR addresses a concrete problem or an agreed enhancement.
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.
Owning docs, contracts, and generated metadata are updated where needed.

_{🔄 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/1355 **Author:** [@akram1089](https://github.com/akram1089) **Created:** 10/9/2026 **Status:** ❌ Closed **Base:** `main` ← **Head:** `docs/readme-fixes` --- ### 📝 Commits (1) - [`b08690c`](https://github.com/morluto/rea/commit/b08690cf0fcf5af898f04fa82b5c254b842be074) docs: clarify README setup command, mention IDA, and update Node badge ### 📊 Changes **17 files changed** (+36 additions, -36 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+4 -4) 📝 `README_ar.md` (+2 -2) 📝 `README_de.md` (+2 -2) 📝 `README_es.md` (+2 -2) 📝 `README_fa.md` (+2 -2) 📝 `README_fr.md` (+2 -2) 📝 `README_ja.md` (+2 -2) 📝 `README_ko.md` (+2 -2) 📝 `README_pl.md` (+2 -2) 📝 `README_pt-BR.md` (+2 -2) 📝 `README_ru.md` (+2 -2) 📝 `README_th.md` (+2 -2) 📝 `README_tr.md` (+2 -2) 📝 `README_uk.md` (+2 -2) 📝 `README_vi.md` (+2 -2) 📝 `README_zh-TW.md` (+2 -2) 📝 `README_zh.md` (+2 -2) </details> ### 📄 Description ## Summary Fixes #1353. Addresses documentation issues reported in the README and translated READMEs: 1. Replaces `rea setup` with `npx rea-agents setup` in the skills.sh FAQ across `README.md` and all 16 translated READMEs so users who only installed the skill can run setup without needing a prior global npm installation. 2. Mentions IDA alongside Hopper and Ghidra in the intro section of `README.md`. 3. Clarifies the supported Node.js version badge (`Node.js 22.19+ · 24.11+ · 26+`) and links to the `#what-you-can-analyze` section across all READMEs. 4. Updates the .NET assemblies requirement row in the table to "None (static only)". ## Problem and expected behavior - In the skills.sh FAQ, `rea setup` assumed a global install of `rea-agents`, which fails for users who only installed the skill from skills.sh. - The intro mentioned native analysis with Hopper or Ghidra, leaving out supported IDA analysis. - The Node.js badge displayed `22+`, whereas Node 23, 24.0-24.10, and 25 are unsupported. - The .NET assemblies row stated "Static inspection" as a requirement rather than "None (static only)". ## Change and scope - Updated `README.md` and 16 translated `README_*.md` files. - Kept link targets consistent with `scripts/lib/docs-facts.mjs`. ## Contract and boundary impact - Semantic owner and earliest changed stage: documentation - 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, package, or installation impact: verified with `npm run docs:check` ## Evidence and regression coverage - Documentation facts check: `npm run docs:check` runs `docs-facts.mjs` verifying link and text parity across all READMEs. ## Validation performed - `npm run docs:check`: passed (all 6 tasks successful, no doc drift) - `npm run check:fast`: passed (typecheck & lint clean) - `npx oxfmt`: passed ## 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: Local documentation change only ## Review checklist - [x] This PR addresses a concrete problem or an agreed enhancement. - [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] Owning docs, contracts, and generated metadata are updated where needed. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-17 21:10:41 +00:00