Skip to content

docs: add Korean translation (README.ko.md) and update language switc…#2043

Merged
senamakel merged 2 commits into
tinyhumansai:mainfrom
shguddn8591:README_kr
May 18, 2026
Merged

docs: add Korean translation (README.ko.md) and update language switc…#2043
senamakel merged 2 commits into
tinyhumansai:mainfrom
shguddn8591:README_kr

Conversation

@shguddn8591
Copy link
Copy Markdown
Contributor

@shguddn8591 shguddn8591 commented May 18, 2026

Summary

  • Added full Korean translation of the main README as README.ko.md.
  • Updated language switchers in English, Chinese, and Japanese README files to include Korean link.
  • Added language-specific badges (shields.io) to all README files for multi-language consistency.
  • Standardized the layout of language selection headers across all localized versions.

Problem

  • The project lacked a Korean translation of the main README, making it less accessible for Korean-speaking users and contributors.
  • Localized README files had inconsistent headers and missing cross-language badges.

Solution

  • Created README.ko.md with a high-quality Korean translation, maintaining all technical links and formatting.
  • Synchronized README.md, README.zh-CN.md, and README.ja-JP.md to ensure they all link to each other and display the correct language badges.
  • Improved the alignment of the language switcher to be consistent across all versions.

Submission Checklist

  • Tests added or updated: N/A: Documentation-only change.
  • Diff coverage ≥ 80%: N/A: Documentation-only change.
  • Coverage matrix updated: N/A: No behavior changes.
  • All affected feature IDs from the matrix are listed: N/A
  • No new external network dependencies introduced: N/A
  • Manual smoke checklist updated: N/A
  • Linked issue closed: N/A

Impact

  • Improved accessibility for the Korean developer community.
  • Professionalized the multi-language documentation structure.

Related

  • Closes: N/A

AI Authored PR Metadata (required for Codex/Linear PRs)

Keep this section for AI-authored PRs. For human-only PRs, mark each field N/A.

Linear Issue

  • Key: N/A
  • URL: N/A

Commit & Branch

  • Branch: README_kr
  • Commit SHA: 026ffe0

Validation Run

  • pnpm --filter openhuman-app format:check
  • pnpm typecheck: N/A
  • Focused tests: N/A
  • Rust fmt/check: N/A
  • Tauri fmt/check: N/A

Validation Blocked

  • command: None
  • error: None

Behavior Changes

  • Intended behavior change: Documentation parity for Korean users.
  • User-visible effect: Users can now access a native Korean version of the README.

Parity Contract

  • Legacy behavior preserved: Yes, original English/Chinese/Japanese versions are preserved and updated with links.

Duplicate / Superseded PR Handling

  • Duplicate PR(s): None
  • Canonical PR: None
  • Resolution: N/A

Summary by CodeRabbit

  • Documentation
    • Added comprehensive Korean documentation with installation steps, feature overviews, and contribution guidelines
    • Expanded the language switcher across all localized READMEs to include Japanese and Korean
    • Updated language badge row and header formatting for clearer navigation and presentation

Review Change Stack

@shguddn8591 shguddn8591 requested a review from a team May 18, 2026 04:44
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 18, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 729c61cb-5d37-4481-b387-aca42fc5531a

📥 Commits

Reviewing files that changed from the base of the PR and between 026ffe0 and 8ed3a53.

📒 Files selected for processing (1)
  • README.ja-JP.md
✅ Files skipped from review due to trivial changes (1)
  • README.ja-JP.md

📝 Walkthrough

Walkthrough

This PR adds a comprehensive Korean translation of the OpenHuman README and updates language navigation across all localized README variants. The Korean translation covers project overview, installation, core features, contribution guidelines, architecture explanation, and competitive positioning. All README files are synchronized to include Korean in their language selectors and badge rows.

Changes

Documentation Localization: Korean Translation and Language Navigation

Layer / File(s) Summary
Korean README Translation
README.ko.md
Complete Korean translation including project introduction, early-beta notice and badges, installation procedures for macOS/Linux/Windows, feature descriptions (UI-first design, 118+ integrations, Memory Tree+Obsidian wiki, native tools, TokenJuice token compression, messaging and encryption), contributing guidelines with development setup and validation commands, context-building explanation with account connection and auto-fetch flow, agent harness comparison table, and contributor honor roll section.
Language Selectors and Badge Synchronization
README.ja-JP.md, README.md, README.zh-CN.md
Updated language navigation links in header sections across localized READMEs to include English, 简体中文, 日本語, 한국어 on a centered row, and replaced/added lang-* badge images to expose English, Simplified Chinese, and Korean badges in the badge row.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • tinyhumansai/openhuman#2005: Previously added the Japanese README and updated language-selector links in README.md and README.zh-CN.md; this PR extends that pattern with Korean translation and synchronized badge updates.
  • tinyhumansai/openhuman#1890: Previously updated the README language switcher and badge row for Simplified Chinese; this PR follows the same pattern for Korean localization.

Suggested reviewers

  • senamakel

Poem

🐰 A rabbit hops through languages wide,
Korean words now by the English side,
Badges bright and selectors aligned,
More tongues to reach, more docs to find! ✨
Hooray for readers everywhere, hopping in to read and bind.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately reflects the main changes: adding Korean translation (README.ko.md) and updating language switchers across multiple README files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.ja-JP.md`:
- Line 40: Replace the incorrect Korean alt text "라이센스" in the README.ja-JP.md
license badge with the correct Japanese "ライセンス"; locate the <img> tag that
currently has alt="라이センス" and update its alt attribute value to "ライセンス" so the
Japanese README displays the correct language in the badge.

In `@README.ko.md`:
- Around line 36-45: Remove the self-referential Korean language badge entry
that links to "./README.ko.md" (the anchor tag with img alt "한국어") so the Korean
README only lists other translations; locate the badge block containing the <a
href="./README.ko.md"><img ... alt="한국어" /></a> element and delete that single
anchor (keeping all other badges intact).
- Line 92: The image tag (<img src="./gitbooks/.gitbook/assets/image (1).png"
/>) in README.ko.md lacks alt text; update the <img> element to include a
concise, descriptive alt attribute that explains the image content (e.g.,
alt="설명하는 한국어 텍스트") so it improves accessibility and SEO—ensure the alt text is
meaningful and not just file name.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 9cb5ca20-246e-4849-af24-e31411764c10

📥 Commits

Reviewing files that changed from the base of the PR and between 8cfc27b and 026ffe0.

📒 Files selected for processing (4)
  • README.ja-JP.md
  • README.ko.md
  • README.md
  • README.zh-CN.md

Comment thread README.ja-JP.md Outdated
Comment thread README.ko.md
Comment on lines +36 to +45
<p align="center">
<img src="https://img.shields.io/badge/status-early%20beta-orange" alt="얼리 베타" />
<a href="https://github.com/tinyhumansai/openhuman/releases/latest"><img src="https://img.shields.io/github/v/release/tinyhumansai/openhuman?label=latest" alt="최신 릴리스" /></a>
<a href="https://github.com/tinyhumansai/openhuman/stargazers"><img src="https://img.shields.io/github/stars/tinyhumansai/openhuman?style=flat" alt="GitHub Stars" /></a>
<a href="./LICENSE"><img src="https://img.shields.io/github/license/tinyhumansai/openhuman" alt="라이선스" /></a>
<a href="./README.md"><img src="https://img.shields.io/badge/lang-English-blue" alt="English" /></a>
<a href="./README.zh-CN.md"><img src="https://img.shields.io/badge/lang-简体中文-blue" alt="简体中文" /></a>
<a href="./README.ja-JP.md"><img src="https://img.shields.io/badge/lang-日本語-blue" alt="日本語" /></a>
<a href="./README.ko.md"><img src="https://img.shields.io/badge/lang-한국어-blue" alt="한국어" /></a>
</p>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Remove the Korean language badge for consistency.

The Korean README includes a badge linking to itself (line 44), which breaks the pattern established by other language variants. Each README should only show badges for other available translations, not its own language.

🔧 Proposed fix
  <a href="./LICENSE"><img src="https://img.shields.io/github/license/tinyhumansai/openhuman" alt="라이선스" /></a>
  <a href="./README.md"><img src="https://img.shields.io/badge/lang-English-blue" alt="English" /></a>
  <a href="./README.zh-CN.md"><img src="https://img.shields.io/badge/lang-简体中文-blue" alt="简体中文" /></a>
  <a href="./README.ja-JP.md"><img src="https://img.shields.io/badge/lang-日本語-blue" alt="日本語" /></a>
- <a href="./README.ko.md"><img src="https://img.shields.io/badge/lang-한국어-blue" alt="한국어" /></a>
 </p>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<p align="center">
<img src="https://img.shields.io/badge/status-early%20beta-orange" alt="얼리 베타" />
<a href="https://github.com/tinyhumansai/openhuman/releases/latest"><img src="https://img.shields.io/github/v/release/tinyhumansai/openhuman?label=latest" alt="최신 릴리스" /></a>
<a href="https://github.com/tinyhumansai/openhuman/stargazers"><img src="https://img.shields.io/github/stars/tinyhumansai/openhuman?style=flat" alt="GitHub Stars" /></a>
<a href="./LICENSE"><img src="https://img.shields.io/github/license/tinyhumansai/openhuman" alt="라이선스" /></a>
<a href="./README.md"><img src="https://img.shields.io/badge/lang-English-blue" alt="English" /></a>
<a href="./README.zh-CN.md"><img src="https://img.shields.io/badge/lang-简体中文-blue" alt="简体中文" /></a>
<a href="./README.ja-JP.md"><img src="https://img.shields.io/badge/lang-日本語-blue" alt="日本語" /></a>
<a href="./README.ko.md"><img src="https://img.shields.io/badge/lang-한국어-blue" alt="한국어" /></a>
</p>
<p align="center">
<img src="https://img.shields.io/badge/status-early%20beta-orange" alt="얼리 베타" />
<a href="https://github.com/tinyhumansai/openhuman/releases/latest"><img src="https://img.shields.io/github/v/release/tinyhumansai/openhuman?label=latest" alt="최신 릴리스" /></a>
<a href="https://github.com/tinyhumansai/openhuman/stargazers"><img src="https://img.shields.io/github/stars/tinyhumansai/openhuman?style=flat" alt="GitHub Stars" /></a>
<a href="./LICENSE"><img src="https://img.shields.io/github/license/tinyhumansai/openhuman" alt="라이선스" /></a>
<a href="./README.md"><img src="https://img.shields.io/badge/lang-English-blue" alt="English" /></a>
<a href="./README.zh-CN.md"><img src="https://img.shields.io/badge/lang-简体中文-blue" alt="简体中文" /></a>
<a href="./README.ja-JP.md"><img src="https://img.shields.io/badge/lang-日本語-blue" alt="日本語" /></a>
</p>
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.ko.md` around lines 36 - 45, Remove the self-referential Korean
language badge entry that links to "./README.ko.md" (the anchor tag with img alt
"한국어") so the Korean README only lists other translations; locate the badge
block containing the <a href="./README.ko.md"><img ... alt="한국어" /></a> element
and delete that single anchor (keeping all other badges intact).

Comment thread README.ko.md
OpenHuman은 몇 분 만에 당신을 알게 되는 최초의 에이전트 하네스입니다. [Karpathy의 LLM 지식 베이스](https://x.com/karpathy/status/2039805659525644595)에서 영감을 받았습니다. 대부분의 에이전트는 아무런 정보 없이 시작합니다. Hermes는 당신의 작업을 지켜보며 학습하고, OpenClaw는 플러그인이 컨텍스트를 가져오기를 기다립니다. 어느 쪽이든 에이전트가 당신의 스택에 대해 충분히 알고 정말 유용해지기까지는 며칠 또는 몇 주가 걸립니다.

<p align="center">
<img src="./gitbooks/.gitbook/assets/image (1).png" />
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Add descriptive alt text to the image.

The image at line 92 is missing alt text, which impacts accessibility and SEO.

♿ Proposed fix
 <p align="center">
- <img src="./gitbooks/.gitbook/assets/image (1).png" />
+ <img src="./gitbooks/.gitbook/assets/image (1).png" alt="OpenHuman 컨텍스트 구축 다이어그램" />
 </p>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<img src="./gitbooks/.gitbook/assets/image (1).png" />
<p align="center">
<img src="./gitbooks/.gitbook/assets/image (1).png" alt="OpenHuman 컨텍스트 구축 다이어그램" />
</p>
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 92-92: Images should have alternate text (alt text)

(MD045, no-alt-text)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.ko.md` at line 92, The image tag (<img
src="./gitbooks/.gitbook/assets/image (1).png" />) in README.ko.md lacks alt
text; update the <img> element to include a concise, descriptive alt attribute
that explains the image content (e.g., alt="설명하는 한국어 텍스트") so it improves
accessibility and SEO—ensure the alt text is meaningful and not just file name.

@senamakel
Copy link
Copy Markdown
Member

I love the koreans :D

@senamakel senamakel merged commit fe87ba7 into tinyhumansai:main May 18, 2026
22 of 24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants