morluto/rea

Fork 0

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

[GH-ISSUE #958] [Docs] Polish and review non-English README translations #369

New issue

Closed

opened 2026-10-15 18:24:20 +00:00 by bsakaguchi · 5 comments

bsakaguchi commented

2026-10-15 18:24:20 +00:00

Owner

Originally created by @N0zoM1z0 on GitHub (Oct 7, 2026).
Original GitHub issue: https://github.com/morluto/rea/issues/958

Ready for translation updates. The English README rewrite was reviewed and merged in #1043, completing #1017. Use the updated English README as the baseline and follow its final structure; reference details now live in the linked guides.

Before submitting

I searched the existing issues for a related documentation report.
I removed credentials, tokens, private paths, and sensitive target data.

Documentation location

The non-English root README files:

Use README.md and the current public contracts as the technical reference.

Problem

The translated READMEs have received incremental feature and documentation updates. We should review their prose as a whole so non-English readers get natural, clear, consistent explanations of REA's current positioning, setup, capabilities, and limitations.

This is a planned language-quality review. It does not assert that every translation is incorrect; concrete language or technical discrepancies should be recorded during the audit.

Expected content

Polish awkward phrasing, literal translations, grammar, punctuation, and paragraph flow in each language.
Use consistent technical terminology within each translation, while retaining recognizable product, provider, and tool names.
Check that explanations of setup, CLI/MCP usage, supported providers, and coverage boundaries agree with the current English README and source contracts.
Preserve executable commands, option names, environment-variable names, URLs, code identifiers, and factual examples unless a separately verified documentation correction is needed.
Preserve useful navigation, links, badges, and code-block formatting; check Arabic bidirectional rendering around commands and identifiers.

Acceptance criteria

Review and polish the Chinese README.
Review and polish the Japanese README.
Review and polish the Korean README.
Review and polish the Arabic README.
Record concrete discrepancies and corrections in the implementation PR(s), distinguishing prose improvements from technical corrections.
Seek fluent-language review where available and explicitly record any language review still outstanding.
Verify links, command examples, Markdown rendering, and npm run docs:check for the edited documentation.

Supporting evidence

The linked README files are the existing translation surfaces. The English README and generated product catalog provide the current product and capability reference. Automated documentation checks can check generated facts, but do not establish translation quality.

Additional context

Requested as follow-up documentation work while website reverse-engineering implementation continues. This issue records the work for a future documentation PR; it does not require broad implementation changes or new translations.

Originally created by @N0zoM1z0 on GitHub (Oct 7, 2026). Original GitHub issue: https://github.com/morluto/rea/issues/958 > **Ready for translation updates.** The English README rewrite was reviewed and merged in #1043, completing #1017. Use the [updated English README](https://github.com/morluto/rea/blob/main/README.md) as the baseline and follow its final structure; reference details now live in the linked guides. ### Before submitting - [x] I searched the existing issues for a related documentation report. - [x] I removed credentials, tokens, private paths, and sensitive target data. ### Documentation location The non-English root README files: - [Chinese: README_zh.md](https://github.com/morluto/rea/blob/main/README_zh.md) - [Japanese: README_ja.md](https://github.com/morluto/rea/blob/main/README_ja.md) - [Korean: README_ko.md](https://github.com/morluto/rea/blob/main/README_ko.md) - [Arabic: README_ar.md](https://github.com/morluto/rea/blob/main/README_ar.md) Use [README.md](https://github.com/morluto/rea/blob/main/README.md) and the current public contracts as the technical reference. ### Problem The translated READMEs have received incremental feature and documentation updates. We should review their prose as a whole so non-English readers get natural, clear, consistent explanations of REA's current positioning, setup, capabilities, and limitations. This is a planned language-quality review. It does not assert that every translation is incorrect; concrete language or technical discrepancies should be recorded during the audit. ### Expected content - Polish awkward phrasing, literal translations, grammar, punctuation, and paragraph flow in each language. - Use consistent technical terminology within each translation, while retaining recognizable product, provider, and tool names. - Check that explanations of setup, CLI/MCP usage, supported providers, and coverage boundaries agree with the current English README and source contracts. - Preserve executable commands, option names, environment-variable names, URLs, code identifiers, and factual examples unless a separately verified documentation correction is needed. - Preserve useful navigation, links, badges, and code-block formatting; check Arabic bidirectional rendering around commands and identifiers. #### Acceptance criteria - [ ] Review and polish the Chinese README. - [ ] Review and polish the Japanese README. - [ ] Review and polish the Korean README. - [ ] Review and polish the Arabic README. - [ ] Record concrete discrepancies and corrections in the implementation PR(s), distinguishing prose improvements from technical corrections. - [ ] Seek fluent-language review where available and explicitly record any language review still outstanding. - [ ] Verify links, command examples, Markdown rendering, and `npm run docs:check` for the edited documentation. ### Supporting evidence The linked README files are the existing translation surfaces. The English README and generated [product catalog](https://github.com/morluto/rea/blob/main/docs/product-catalog.json) provide the current product and capability reference. Automated documentation checks can check generated facts, but do not establish translation quality. ### Additional context Requested as follow-up documentation work while website reverse-engineering implementation continues. This issue records the work for a future documentation PR; it does not require broad implementation changes or new translations.

bsakaguchi

2026-10-15 18:24:20 +00:00

closed this issue
added the
help wanted

triage

documentation

P2: medium
labels

bsakaguchi commented

2026-10-15 18:24:21 +00:00

Author

Owner

@N0zoM1z0 commented on GitHub (Oct 7, 2026):

Temporarily blocking this issue on #1017 while we simplify and reorganize the English README. Please hold off on further README translation work until the revised English version is reviewed and merged; we'll then resume using that version as the reference.

This pause applies to README translations only. Website multilingual work in #1022 can continue.

@N0zoM1z0 commented on GitHub (Oct 7, 2026): Temporarily blocking this issue on #1017 while we simplify and reorganize the English README. Please hold off on further README translation work until the revised English version is reviewed and merged; we'll then resume using that version as the reference. This pause applies to README translations only. Website multilingual work in #1022 can continue.

bsakaguchi commented

2026-10-15 18:24:21 +00:00

Author

Owner

@N0zoM1z0 commented on GitHub (Oct 8, 2026):

Unblocked! The English README rewrite has been reviewed and merged in #1043, so translation work can continue.

Please use the updated English README as the baseline and follow its shorter structure. Keep the wording natural, clear and easy to follow; detailed technical information now lives in the linked guides.

Contributions for Chinese, Japanese, Korean and Arabic are welcome. If you'd like to help, comment with the language you'd like to work on and open a PR linked to this issue.

@N0zoM1z0 commented on GitHub (Oct 8, 2026): Unblocked! The English README rewrite has been reviewed and merged in #1043, so translation work can continue. Please use the [updated English README](https://github.com/morluto/rea/blob/main/README.md) as the baseline and follow its shorter structure. Keep the wording natural, clear and easy to follow; detailed technical information now lives in the linked guides. Contributions for Chinese, Japanese, Korean and Arabic are welcome. If you'd like to help, comment with the language you'd like to work on and open a PR linked to this issue.

bsakaguchi commented

2026-10-15 18:24:22 +00:00

Author

Owner

@BaaRai commented on GitHub (Oct 8, 2026):

I'd like to take Chinese (README_zh.md), restructured against the post-#1043 English baseline.

@BaaRai commented on GitHub (Oct 8, 2026): I'd like to take Chinese (README_zh.md), restructured against the post-#1043 English baseline.

bsakaguchi commented

2026-10-15 18:24:22 +00:00

Author

Owner

@BaaRai commented on GitHub (Oct 8, 2026):

Withdrawing my Chinese claim above: d83f0983 restructured and retranslated all four languages, including Chinese.

@BaaRai commented on GitHub (Oct 8, 2026): Withdrawing my Chinese claim above: d83f0983 restructured and retranslated all four languages, including Chinese.

bsakaguchi commented

2026-10-15 18:24:22 +00:00

Author

Owner

@morluto commented on GitHub (Oct 9, 2026):

Closing as completed: d83f0983 ('docs: align translated READMEs and website links with English', now in main) restructured and retranslated all four READMEs (zh/ja/ko/ar) against the post-#1043 English baseline and extended the readme-consistency conformance test — exactly the work this issue tracked, as @BaaRai noted when withdrawing the Chinese claim. Thanks all; please open a new issue for any remaining per-language polish.

@morluto commented on GitHub (Oct 9, 2026): Closing as completed: d83f0983 ('docs: align translated READMEs and website links with English', now in main) restructured and retranslated all four READMEs (zh/ja/ko/ar) against the post-#1043 English baseline and extended the readme-consistency conformance test — exactly the work this issue tracked, as @BaaRai noted when withdrawing the Chinese claim. Thanks all; please open a new issue for any remaining per-language polish.

bsakaguchi referenced this issue

2026-10-16 21:08:52 +00:00

[GH-ISSUE #4248] [Feature] Add a provider-neutral MCP prompt for static vulnerability review of native binaries #1672

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

No description provided.

Rows
Columns