[PR #2067] [CLOSED] docs(readme): add responsible-use guidance and reframe the introduction #5002

New issue

Closed

opened 2026-10-31 00:57:53 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-31 00:57:53 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/2067
Author: @kaoru0822-kitauji
Created: 10/12/2026
Status: ❌ Closed

Base: main ← Head: docs/readme-responsible-use

📝 Commits (1)

b6d8bb6 docs(readme): add responsible-use guidance and reframe the introduction

📊 Changes

19 files changed (+437 additions, -98 deletions)

View changed files

📝 README.md (+23 -6)
📝 README_ar.md (+23 -5)
📝 README_de.md (+23 -5)
📝 README_es.md (+23 -5)
📝 README_fa.md (+23 -5)
📝 README_fr.md (+23 -6)
📝 README_id.md (+23 -5)
📝 README_it.md (+23 -6)
📝 README_ja.md (+23 -5)
📝 README_ko.md (+23 -5)
📝 README_pl.md (+23 -5)
📝 README_pt-BR.md (+23 -5)
📝 README_ru.md (+23 -5)
📝 README_th.md (+23 -5)
📝 README_tr.md (+23 -5)
📝 README_uk.md (+23 -5)
📝 README_vi.md (+23 -5)
📝 README_zh-TW.md (+23 -5)
📝 README_zh.md (+23 -5)

📄 Description

Summary

Reframes the README introduction around security research, interoperability and authorized analysis, and adds a "Responsible use" section. The English README is the reference; all 18 translations get the same six changes.

Changes

Tagline: "See a feature you like. Understand how it works, down to the binary level." becomes "Understand how software works, down to the binary level — for security research, interoperability, and software you're authorized to analyze."
Opening paragraph: now describes who REA is for (security researchers, malware analysts, CTF players, developers) and says to point the agent at a target you're authorized to analyze.
New "Responsible use" section before "Quick start". It covers lawful uses, six unsupported uses, the user's legal and licensing responsibilities, and closing of requests for those uses in issues and discussions.
Quick start example prompt: the Notes feature-copy prompt is replaced with a release-vs-debug startup crash investigation of ./build/MyApp.
Line below the example: "Point your agent at a target you're authorized to analyze and describe what you want to understand."
Disclaimer: the first paragraph becomes a link to the new section. The heading and the cryptocurrency/token paragraph are unchanged.

Translations

Each file follows its own conventions: polite or informal address, agent and evidence terms, how it refers to issues and captures, and whether the example prompt is translated (all 18 translate it).
Every link to the new section uses the anchor GitHub generates for that file's translated heading, for example #verantwortungsvolle-nutzung, #استفادهٔ-مسئولانه and #責任ある利用. Before applying, I checked the anchor rule against every existing table-of-contents link in all 19 files.
In the Persian README the new section sits inside the existing <div dir="rtl">, like the rest of its body.

Files

README.md, README_ar.md, README_de.md, README_es.md, README_fa.md, README_fr.md, README_id.md, README_it.md, README_ja.md, README_ko.md, README_pl.md, README_pt-BR.md, README_ru.md, README_th.md, README_tr.md, README_uk.md, README_vi.md, README_zh.md, README_zh-TW.md

No other files changed.

Validation

npm run docs:check passed.
npm run format:check passed.
Each file's diff has the same shape: 23 lines added, and 5 or 6 removed depending on whether the old prompt wrapped onto two lines.

🤖 Generated with Claude Code

_{🔄 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/2067 **Author:** [@kaoru0822-kitauji](https://github.com/kaoru0822-kitauji) **Created:** 10/12/2026 **Status:** ❌ Closed **Base:** `main` ← **Head:** `docs/readme-responsible-use` --- ### 📝 Commits (1) - [`b6d8bb6`](https://github.com/morluto/rea/commit/b6d8bb65d313ad73ab5567b68b5e56e56ac557f3) docs(readme): add responsible-use guidance and reframe the introduction ### 📊 Changes **19 files changed** (+437 additions, -98 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+23 -6) 📝 `README_ar.md` (+23 -5) 📝 `README_de.md` (+23 -5) 📝 `README_es.md` (+23 -5) 📝 `README_fa.md` (+23 -5) 📝 `README_fr.md` (+23 -6) 📝 `README_id.md` (+23 -5) 📝 `README_it.md` (+23 -6) 📝 `README_ja.md` (+23 -5) 📝 `README_ko.md` (+23 -5) 📝 `README_pl.md` (+23 -5) 📝 `README_pt-BR.md` (+23 -5) 📝 `README_ru.md` (+23 -5) 📝 `README_th.md` (+23 -5) 📝 `README_tr.md` (+23 -5) 📝 `README_uk.md` (+23 -5) 📝 `README_vi.md` (+23 -5) 📝 `README_zh-TW.md` (+23 -5) 📝 `README_zh.md` (+23 -5) </details> ### 📄 Description ## Summary Reframes the README introduction around security research, interoperability and authorized analysis, and adds a "Responsible use" section. The English README is the reference; all 18 translations get the same six changes. ## Changes 1. **Tagline:** "See a feature you like. Understand how it works, down to the binary level." becomes "Understand how software works, down to the binary level — for security research, interoperability, and software you're authorized to analyze." 2. **Opening paragraph:** now describes who REA is for (security researchers, malware analysts, CTF players, developers) and says to point the agent at a target you're authorized to analyze. 3. **New "Responsible use" section** before "Quick start". It covers lawful uses, six unsupported uses, the user's legal and licensing responsibilities, and closing of requests for those uses in issues and discussions. 4. **Quick start example prompt:** the Notes feature-copy prompt is replaced with a release-vs-debug startup crash investigation of `./build/MyApp`. 5. **Line below the example:** "Point your agent at a target you're authorized to analyze and describe what you want to understand." 6. **Disclaimer:** the first paragraph becomes a link to the new section. The heading and the cryptocurrency/token paragraph are unchanged. ## Translations - Each file follows its own conventions: polite or informal address, agent and evidence terms, how it refers to issues and captures, and whether the example prompt is translated (all 18 translate it). - Every link to the new section uses the anchor GitHub generates for that file's translated heading, for example `#verantwortungsvolle-nutzung`, `#استفادهٔ-مسئولانه` and `#責任ある利用`. Before applying, I checked the anchor rule against every existing table-of-contents link in all 19 files. - In the Persian README the new section sits inside the existing `<div dir="rtl">`, like the rest of its body. ## Files `README.md`, `README_ar.md`, `README_de.md`, `README_es.md`, `README_fa.md`, `README_fr.md`, `README_id.md`, `README_it.md`, `README_ja.md`, `README_ko.md`, `README_pl.md`, `README_pt-BR.md`, `README_ru.md`, `README_th.md`, `README_tr.md`, `README_uk.md`, `README_vi.md`, `README_zh.md`, `README_zh-TW.md` No other files changed. ## Validation - `npm run docs:check` passed. - `npm run format:check` passed. - Each file's diff has the same shape: 23 lines added, and 5 or 6 removed depending on whether the old prompt wrapped onto two lines. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-31 00:57:53 +00:00