morluto/rea

Fork 0

mirror of https://github.com/morluto/rea.git synced 2026-11-05 06:45:22 +00:00

[PR #2681] [CLOSED] docs: move translated READMEs into docs/readmes #5308

New issue

Closed

opened 2026-10-31 01:05:37 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-31 01:05:37 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/2681
Author: @Niroop2004
Created: 10/13/2026
Status: ❌ Closed

Base: main ← Head: docs/move-readmes-to-docs-readmes

📝 Commits (2)

465b5ce docs: move translated READMEs into docs/readmes
e71763d docs: reconcile translated README paths with main

📊 Changes

28 files changed (+1025 additions, -917 deletions)

View changed files

📝 README.md (+1 -1)
📝 docs/.vitepress/config.ts (+1 -0)
📝 docs/readmes/README_ar.md (+47 -47)
📝 docs/readmes/README_de.md (+47 -47)
📝 docs/readmes/README_es.md (+47 -47)
📝 docs/readmes/README_fa.md (+47 -47)
📝 docs/readmes/README_fr.md (+48 -48)
📝 docs/readmes/README_id.md (+51 -51)
📝 docs/readmes/README_it.md (+48 -48)
📝 docs/readmes/README_ja.md (+47 -47)
📝 docs/readmes/README_ko.md (+47 -47)
📝 docs/readmes/README_pl.md (+47 -47)
📝 docs/readmes/README_pt-BR.md (+47 -47)
📝 docs/readmes/README_ru.md (+47 -47)
📝 docs/readmes/README_th.md (+47 -47)
📝 docs/readmes/README_tr.md (+47 -47)
📝 docs/readmes/README_uk.md (+47 -47)
📝 docs/readmes/README_vi.md (+47 -47)
📝 docs/readmes/README_zh-TW.md (+47 -47)
📝 docs/readmes/README_zh.md (+47 -47)

...and 8 more files

📄 Description

Summary

The 18 translated READMEs (README_<lang>.md) cluttered the repository root. They now live in one folder, docs/readmes/. The English README.md stays at the root so GitHub and npm still show it.

No issue is linked; this is a small documentation cleanup.

Problem and expected behavior

Readers pick a language from the language bar at the top of each README. Expected after the move:

every language link and every relative link (docs, images, LICENSE) still works
the docs and website checks still find all 19 README editions

Change and scope

Moved all 18 translations with git mv, so history is kept as renames.
Updated relative links in the moved files (for example docs/installation.md → ../installation.md, LICENSE → ../../LICENSE).
Updated the language bar in README.md to point to docs/readmes/.
Updated tooling that assumed translations were at the root:
- website/locales/languages.json: readme paths
- scripts/website_i18n.py: discovers editions in the root and in docs/readmes/
- scripts/lib/docs-facts.mjs: link-parity check resolves links relative to each README
- scripts/ci/plan.mjs, scripts/ci/scopes.mjs: CI change-scope rules
No translated text changed.

Contribution scope: documentation layout only. A maintainer scope decision is not applicable.

Contract and boundary impact

Semantic owner and earliest changed stage: README editions and website/locales/languages.json
Contribution scope fit and linked maintainer decision: documentation only; 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: not applicable
Generated metadata, package, or installation impact: none; translated READMEs are not part of the npm package
Documentation or usability only; no target interaction.

Evidence and regression coverage

Tests added or updated: tests/conformance/readmeConsistency.test.ts, tests/boundary/filesystem/productCatalog.test.ts, tests/boundary/filesystem/ciChangeScope.test.ts now use docs/readmes/
Base reproduction or other evidence: all 1,330 local link targets in the 19 READMEs resolve to existing files; all 19 readme paths in languages.json exist
User-visible CLI/MCP output: not applicable
Remaining proof gaps: ciChangeScope.test.ts was not run locally (see Validation); scripts/website_i18n.py was not run (polib not installed locally)

Validation performed

npm run check:fast — passed
npm run docs:check — passed
npm run test:focused -- tests/boundary/filesystem/productCatalog.test.ts — 11/11 passed
npm run test:local -- tests/conformance/readmeConsistency.test.ts — 2/2 passed
npx oxfmt --check on changed files — passed
npm run test:focused -- tests/boundary/filesystem/ciChangeScope.test.ts — fails on Windows before running. Line 86 uses new URL(...).pathname, which gives C:\C:\.... This PR does not change that line. Relying on Linux CI for this test.

Compatibility, safety, and release

Breaking changes or migration steps: none for the code or package. External links to the old root README_<lang>.md URLs will no longer resolve.
Real Hopper/Ghidra, browser, or OS coverage: not applicable
Package or release metadata impact: none
Security, privacy, process, or containment review: not applicable

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/2681 **Author:** [@Niroop2004](https://github.com/Niroop2004) **Created:** 10/13/2026 **Status:** ❌ Closed **Base:** `main` ← **Head:** `docs/move-readmes-to-docs-readmes` --- ### 📝 Commits (2) - [`465b5ce`](https://github.com/morluto/rea/commit/465b5ce574c23d9aa41b4a04d2104df2124a612f) docs: move translated READMEs into docs/readmes - [`e71763d`](https://github.com/morluto/rea/commit/e71763df9d7039dae7bdf1cea6d1ddcb6f183ec2) docs: reconcile translated README paths with main ### 📊 Changes **28 files changed** (+1025 additions, -917 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+1 -1) 📝 `docs/.vitepress/config.ts` (+1 -0) 📝 `docs/readmes/README_ar.md` (+47 -47) 📝 `docs/readmes/README_de.md` (+47 -47) 📝 `docs/readmes/README_es.md` (+47 -47) 📝 `docs/readmes/README_fa.md` (+47 -47) 📝 `docs/readmes/README_fr.md` (+48 -48) 📝 `docs/readmes/README_id.md` (+51 -51) 📝 `docs/readmes/README_it.md` (+48 -48) 📝 `docs/readmes/README_ja.md` (+47 -47) 📝 `docs/readmes/README_ko.md` (+47 -47) 📝 `docs/readmes/README_pl.md` (+47 -47) 📝 `docs/readmes/README_pt-BR.md` (+47 -47) 📝 `docs/readmes/README_ru.md` (+47 -47) 📝 `docs/readmes/README_th.md` (+47 -47) 📝 `docs/readmes/README_tr.md` (+47 -47) 📝 `docs/readmes/README_uk.md` (+47 -47) 📝 `docs/readmes/README_vi.md` (+47 -47) 📝 `docs/readmes/README_zh-TW.md` (+47 -47) 📝 `docs/readmes/README_zh.md` (+47 -47) _...and 8 more files_ </details> ### 📄 Description ## Summary The 18 translated READMEs (`README_<lang>.md`) cluttered the repository root. They now live in one folder, `docs/readmes/`. The English `README.md` stays at the root so GitHub and npm still show it. No issue is linked; this is a small documentation cleanup. ## Problem and expected behavior Readers pick a language from the language bar at the top of each README. Expected after the move: - every language link and every relative link (docs, images, LICENSE) still works - the docs and website checks still find all 19 README editions ## Change and scope - Moved all 18 translations with `git mv`, so history is kept as renames. - Updated relative links in the moved files (for example `docs/installation.md` → `../installation.md`, `LICENSE` → `../../LICENSE`). - Updated the language bar in `README.md` to point to `docs/readmes/`. - Updated tooling that assumed translations were at the root: - `website/locales/languages.json`: `readme` paths - `scripts/website_i18n.py`: discovers editions in the root and in `docs/readmes/` - `scripts/lib/docs-facts.mjs`: link-parity check resolves links relative to each README - `scripts/ci/plan.mjs`, `scripts/ci/scopes.mjs`: CI change-scope rules - No translated text changed. Contribution scope: documentation layout only. A maintainer scope decision is not applicable. ## Contract and boundary impact - Semantic owner and earliest changed stage: README editions and `website/locales/languages.json` - Contribution scope fit and linked maintainer decision: documentation only; 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: not applicable - Generated metadata, package, or installation impact: none; translated READMEs are not part of the npm package - [x] Documentation or usability only; no target interaction. ## Evidence and regression coverage - Tests added or updated: `tests/conformance/readmeConsistency.test.ts`, `tests/boundary/filesystem/productCatalog.test.ts`, `tests/boundary/filesystem/ciChangeScope.test.ts` now use `docs/readmes/` - Base reproduction or other evidence: all 1,330 local link targets in the 19 READMEs resolve to existing files; all 19 `readme` paths in `languages.json` exist - User-visible CLI/MCP output: not applicable - Remaining proof gaps: `ciChangeScope.test.ts` was not run locally (see Validation); `scripts/website_i18n.py` was not run (`polib` not installed locally) ## Validation performed - `npm run check:fast` — passed - `npm run docs:check` — passed - `npm run test:focused -- tests/boundary/filesystem/productCatalog.test.ts` — 11/11 passed - `npm run test:local -- tests/conformance/readmeConsistency.test.ts` — 2/2 passed - `npx oxfmt --check` on changed files — passed - `npm run test:focused -- tests/boundary/filesystem/ciChangeScope.test.ts` — fails on Windows before running. Line 86 uses `new URL(...).pathname`, which gives `C:\C:\...`. This PR does not change that line. Relying on Linux CI for this test. ## Compatibility, safety, and release - Breaking changes or migration steps: none for the code or package. External links to the old root `README_<lang>.md` URLs will no longer resolve. - Real Hopper/Ghidra, browser, or OS coverage: not applicable - Package or release metadata impact: none - Security, privacy, process, or containment review: not applicable ## 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. - [x] Tests cover changed observable behavior and meaningful failure paths. - [x] Owning docs, contracts, and generated metadata are updated where needed. - [x] 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:05:37 +00:00

closed this issue
added the
pull-request
label

bsakaguchi referenced this issue

2026-11-01 21:43:42 +00:00

[PR #5308] [CLOSED] fix(ghidra): keep a stable JAVA_HOME spelling for clients #6872

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#5308

No description provided.

Rows
Columns