[PR #4570] [CLOSED] docs(i18n): sync Go, SQLite and Bun update facts in translated READMEs #6311

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/4570
Author: @himanshug9119
Created: 10/16/2026
Status: ❌ Closed

Base: main ← Head: docs/readme-table-bun-sync


📝 Commits (4)

  • cde6e3b docs(i18n): sync Go, SQLite and Bun update facts in translated READMEs
  • 8a260ac Merge branch 'main' into docs/readme-table-bun-sync
  • c2b15e7 docs(i18n): apply Indonesian review wording for Go replace and SQLite rows
  • 24b07d3 Merge branch 'main' into docs/readme-table-bun-sync

📊 Changes

15 files changed (+78 additions, -30 deletions)

View changed files

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

📄 Description

Summary

Refs #4564

The English README lists Go binaries and SQLite databases under "What you can analyze" and documents Bun global installs under "Update REA" and the FAQ. Most translated READMEs predate these additions.

Problem and expected behavior

Readers of most translated editions can't see that REA inspects Go binaries or SQLite databases, and Bun users aren't told that rea update supports bun add --global installs, that it needs Bun 1.2.17 or later, or that bunx can replace npx. Expected: each edition carries the same facts as README.md.

Change and scope

  • Add the Go binaries row after "Offline ELF layout", matching the English order (13 editions).
  • Add the SQLite databases row after "EVM bytecode" (15 editions).
  • In "Update REA" and the FAQ update answer, mention bun add --global. In "Update REA", add the Bun 1.2.17 paragraph and the bunx sentence (10 editions).
  • Each edition keeps its own cell separator and existing terms; tables were realigned with oxfmt.
  • Not included: README_ar.md (left to #4139). The procps prerequisite is in a separate PR. Translated editions also still carry an older, English-only "Rust binaries" row; that isn't changed here.

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 rows are not covered by readmeConsistency.test.ts)
  • Base reproduction or other evidence: with the check command from the linked issue, main (8116dc0) is missing the Go row in 14 editions, SQLite in 16 and bun add --global in 11. On this branch each is missing only in 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 docs:check (includes readmeConsistency.test.ts, 5/5): 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/4570 **Author:** [@himanshug9119](https://github.com/himanshug9119) **Created:** 10/16/2026 **Status:** ❌ Closed **Base:** `main` ← **Head:** `docs/readme-table-bun-sync` --- ### 📝 Commits (4) - [`cde6e3b`](https://github.com/morluto/rea/commit/cde6e3b13d754e75f7360ee0dc595dee94b3069f) docs(i18n): sync Go, SQLite and Bun update facts in translated READMEs - [`8a260ac`](https://github.com/morluto/rea/commit/8a260ac7391c46b43c89385c064c1b71f97948c6) Merge branch 'main' into docs/readme-table-bun-sync - [`c2b15e7`](https://github.com/morluto/rea/commit/c2b15e7f51ab8e3bd759baf1733f4c453006094b) docs(i18n): apply Indonesian review wording for Go replace and SQLite rows - [`24b07d3`](https://github.com/morluto/rea/commit/24b07d34445fc7efbd04e3c6a43e3118bb39e7a1) Merge branch 'main' into docs/readme-table-bun-sync ### 📊 Changes **15 files changed** (+78 additions, -30 deletions) <details> <summary>View changed files</summary> 📝 `docs/readme/README_de.md` (+7 -3) 📝 `docs/readme/README_es.md` (+7 -3) 📝 `docs/readme/README_fa.md` (+7 -3) 📝 `docs/readme/README_fr.md` (+2 -0) 📝 `docs/readme/README_id.md` (+2 -0) 📝 `docs/readme/README_it.md` (+2 -0) 📝 `docs/readme/README_ja.md` (+7 -3) 📝 `docs/readme/README_pl.md` (+7 -3) 📝 `docs/readme/README_pt-BR.md` (+7 -3) 📝 `docs/readme/README_ru.md` (+7 -3) 📝 `docs/readme/README_th.md` (+7 -3) 📝 `docs/readme/README_uk.md` (+7 -3) 📝 `docs/readme/README_vi.md` (+7 -3) 📝 `docs/readme/README_zh-TW.md` (+1 -0) 📝 `docs/readme/README_zh.md` (+1 -0) </details> ### 📄 Description ## Summary Refs #4564 The English README lists Go binaries and SQLite databases under "What you can analyze" and documents Bun global installs under "Update REA" and the FAQ. Most translated READMEs predate these additions. ## Problem and expected behavior Readers of most translated editions can't see that REA inspects Go binaries or SQLite databases, and Bun users aren't told that `rea update` supports `bun add --global` installs, that it needs Bun 1.2.17 or later, or that `bunx` can replace `npx`. Expected: each edition carries the same facts as `README.md`. ## Change and scope - Add the **Go binaries** row after "Offline ELF layout", matching the English order (13 editions). - Add the **SQLite databases** row after "EVM bytecode" (15 editions). - In "Update REA" and the FAQ update answer, mention `bun add --global`. In "Update REA", add the Bun 1.2.17 paragraph and the `bunx` sentence (10 editions). - Each edition keeps its own cell separator and existing terms; tables were realigned with `oxfmt`. - Not included: `README_ar.md` (left to #4139). The procps prerequisite is in a separate PR. Translated editions also still carry an older, English-only "Rust binaries" row; that isn't changed here. 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 rows are not covered by `readmeConsistency.test.ts`) - Base reproduction or other evidence: with the check command from the linked issue, `main` (8116dc0) is missing the Go row in 14 editions, SQLite in 16 and `bun add --global` in 11. On this branch each is missing only in `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 docs:check` (includes `readmeConsistency.test.ts`, 5/5): 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#6311
No description provided.