[PR #5236] [CLOSED] docs(readme): carry update alias and output bound into Korean guide #6830

Closed
opened 2026-11-01 21:43:21 +00:00 by bsakaguchi · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/morluto/rea/pull/5236
Author: @chordpli
Created: 10/19/2026
Status: ❌ Closed

Base: main ← Head: docs/ko-readme-update-guidance


📝 Commits (2)

  • db3596f docs(readme): carry update alias and output bound into Korean guide
  • 020e541 docs(readme): clarify Korean update alias and output bound wording

📊 Changes

1 file changed (+4 additions, -0 deletions)

View changed files

📝 docs/readme/README_ko.md (+4 -0)

📄 Description

Summary

Fixes #5085.

The Korean README's "REA 업데이트" section went straight from the rea update example to the Bun requirement. It left out two paragraphs that the English "Update REA" section has: the rea --update alias, and the 4 MiB output bound with its progress behavior. This change adds both paragraphs to the Korean section.

Problem and expected behavior

Korean readers did not learn that rea --update exists, that it accepts the same global output flags, or that updater commands keep at most 4 MiB of combined stdout and stderr. CONTRIBUTING.md names the English README as the reference for commands and requirements, so the Korean section should carry the same facts.

Change and scope

  • docs/readme/README_ko.md: add Korean translations of the two English paragraphs, in the same position (after the rea update example, before the Bun requirement). Commands, flags and the 4 MiB figure are kept verbatim.

Not included: every other README translation under docs/readme/ (20 files, including README_ja.md and README_zh.md) is also missing both paragraphs. The issue is scoped to Korean, and I can only review Korean wording, so I left the other languages unchanged.

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

Contract and boundary impact

  • Semantic owner and earliest changed stage: the Korean README translation.
  • Contribution scope fit and linked maintainer decision: not applicable (documentation only).
  • 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 (docs/public/product-catalog.json), package, or installation impact: none.

Expected effects (check known effects; use documentation-only on its own).
Unchecked items do not establish absence; leave uncertainties visible.

  • Read existing files or captured data.
  • Launch or attach to a process.
  • Inject instrumentation or run scripts/code.
  • Change process memory, registers, files, or configuration.
  • Contact network services.
  • Recover protected code or work around protections.
  • Documentation or usability only; no target interaction.
  • Not sure yet; investigation or maintainer guidance needed.

Evidence and regression coverage

  • Tests added or updated: none. This is a translation gap, not a behavior change.
  • Base reproduction or other evidence (executed): the content comparison from #5085 printed alias: English=True; Korean=False and output bound: English=True; Korean=False on the base revision. On this branch it prints Korean=True for both.
  • User-visible CLI/MCP output (if applicable): not applicable.
  • Remaining proof gaps: the rendered page was not previewed on the website. The other README translations still lack these paragraphs (see above).

For evidence-bearing changes:

  • Observed, derived, and inferred claims remain distinguishable.
  • Artifact identity, source provenance, and failed attempts remain preserved.
  • Unsupported, incomplete, unavailable, or uncertain outcomes remain visible.

Validation performed

  • Content comparison script from #5085: alias: English=True; Korean=True, output bound: English=True; Korean=True
  • npx oxfmt --check docs/readme/README_ko.md: correct format
  • npm run test:focused -- tests/conformance/readmeConsistency.test.ts: 5 passed
  • npm run test:focused -- tests/boundary/filesystem/documentationFacts.test.ts: 1 passed
  • npm run docs:check: passed

Compatibility, safety, and release

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

Author readiness

Human owner: @chordpli

  • 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/5236 **Author:** [@chordpli](https://github.com/chordpli) **Created:** 10/19/2026 **Status:** ❌ Closed **Base:** `main` ← **Head:** `docs/ko-readme-update-guidance` --- ### 📝 Commits (2) - [`db3596f`](https://github.com/morluto/rea/commit/db3596f2558da0bb9c1d60f9480f629571213f29) docs(readme): carry update alias and output bound into Korean guide - [`020e541`](https://github.com/morluto/rea/commit/020e541e771ef08a9d59c64ae7dcc994666519ff) docs(readme): clarify Korean update alias and output bound wording ### 📊 Changes **1 file changed** (+4 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `docs/readme/README_ko.md` (+4 -0) </details> ### 📄 Description ## Summary Fixes #5085. The Korean README's "REA 업데이트" section went straight from the `rea update` example to the Bun requirement. It left out two paragraphs that the English "Update REA" section has: the `rea --update` alias, and the 4 MiB output bound with its progress behavior. This change adds both paragraphs to the Korean section. ## Problem and expected behavior Korean readers did not learn that `rea --update` exists, that it accepts the same global output flags, or that updater commands keep at most 4 MiB of combined stdout and stderr. [CONTRIBUTING.md](https://github.com/morluto/rea/blob/main/CONTRIBUTING.md#translation-corrections) names the English README as the reference for commands and requirements, so the Korean section should carry the same facts. ## Change and scope - `docs/readme/README_ko.md`: add Korean translations of the two English paragraphs, in the same position (after the `rea update` example, before the Bun requirement). Commands, flags and the `4 MiB` figure are kept verbatim. Not included: every other README translation under `docs/readme/` (20 files, including `README_ja.md` and `README_zh.md`) is also missing both paragraphs. The issue is scoped to Korean, and I can only review Korean wording, so I left the other languages unchanged. Contribution scope: documentation-only fix. A maintainer scope decision is not applicable. ## Contract and boundary impact - Semantic owner and earliest changed stage: the Korean README translation. - Contribution scope fit and linked maintainer decision: not applicable (documentation only). - 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 (`docs/public/product-catalog.json`), package, or installation impact: none. Expected effects (check known effects; use documentation-only on its own). Unchecked items do not establish absence; leave uncertainties visible. - [ ] Read existing files or captured data. - [ ] Launch or attach to a process. - [ ] Inject instrumentation or run scripts/code. - [ ] Change process memory, registers, files, or configuration. - [ ] Contact network services. - [ ] Recover protected code or work around protections. - [x] Documentation or usability only; no target interaction. - [ ] Not sure yet; investigation or maintainer guidance needed. ## Evidence and regression coverage - Tests added or updated: none. This is a translation gap, not a behavior change. - Base reproduction or other evidence (executed): the content comparison from #5085 printed `alias: English=True; Korean=False` and `output bound: English=True; Korean=False` on the base revision. On this branch it prints `Korean=True` for both. - User-visible CLI/MCP output (if applicable): not applicable. - Remaining proof gaps: the rendered page was not previewed on the website. The other README translations still lack these paragraphs (see above). For evidence-bearing changes: - [ ] Observed, derived, and inferred claims remain distinguishable. - [ ] Artifact identity, source provenance, and failed attempts remain preserved. - [ ] Unsupported, incomplete, unavailable, or uncertain outcomes remain visible. ## Validation performed - Content comparison script from #5085: `alias: English=True; Korean=True`, `output bound: English=True; Korean=True` - `npx oxfmt --check docs/readme/README_ko.md`: correct format - `npm run test:focused -- tests/conformance/readmeConsistency.test.ts`: 5 passed - `npm run test:focused -- tests/boundary/filesystem/documentationFacts.test.ts`: 1 passed - `npm run docs:check`: passed ## Compatibility, safety, and release - Breaking changes or migration steps: none. - Real Hopper/Ghidra, browser, or OS coverage: not applicable. - Package or release metadata impact: none. - Security, privacy, process, or containment review: none. ## Author readiness Human owner: @chordpli - [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 - [ ] 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. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
bsakaguchi 2026-11-01 21:43:21 +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#6830
No description provided.