Skip to content

docs: add Japanese README#2005

Merged
senamakel merged 1 commit into
tinyhumansai:mainfrom
eltociear:add-ja-doc
May 18, 2026
Merged

docs: add Japanese README#2005
senamakel merged 1 commit into
tinyhumansai:mainfrom
eltociear:add-ja-doc

Conversation

@eltociear
Copy link
Copy Markdown
Contributor

@eltociear eltociear commented May 17, 2026

Summary

  • I created Japanese translated README.

Problem

  • What issue or risk this PR addresses.
  • Include context needed for reviewers to evaluate correctness quickly.

Solution

  • How the implementation solves the problem.
  • Note important design decisions and tradeoffs.

Submission Checklist

If a section does not apply to this change, mark the item as N/A with a one-line reason. Do not delete items.

  • Tests added or updated (happy path + at least one failure / edge case) per Testing Strategy
  • Diff coverage ≥ 80% — changed lines (Vitest + cargo-llvm-cov merged via diff-cover) meet the gate enforced by .github/workflows/coverage.yml. Run pnpm test:coverage and pnpm test:rust locally; PRs below 80% on changed lines will not merge.
  • Coverage matrix updated — added/removed/renamed feature rows in docs/TEST-COVERAGE-MATRIX.md reflect this change (or N/A: behaviour-only change)
  • All affected feature IDs from the matrix are listed in the PR description under ## Related
  • No new external network dependencies introduced (mock backend used per Testing Strategy)
  • Manual smoke checklist updated if this touches release-cut surfaces (docs/RELEASE-MANUAL-SMOKE.md)
  • Linked issue closed via Closes #NNN in the ## Related section

Impact

  • Runtime/platform impact (desktop/mobile/web/CLI), if any.
  • Performance, security, migration, or compatibility implications.

Related

  • Closes:
  • Follow-up PR(s)/TODOs:

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:
  • URL:

Commit & Branch

  • Branch:
  • Commit SHA:

Validation Run

  • pnpm --filter openhuman-app format:check
  • pnpm typecheck
  • Focused tests:
  • Rust fmt/check (if changed):
  • Tauri fmt/check (if changed):

Validation Blocked

  • command:
  • error:
  • impact:

Behavior Changes

  • Intended behavior change:
  • User-visible effect:

Parity Contract

  • Legacy behavior preserved:
  • Guard/fallback/dispatch parity checks:

Duplicate / Superseded PR Handling

  • Duplicate PR(s):
  • Canonical PR:
  • Resolution (closed/superseded/updated):

Summary by CodeRabbit

  • Documentation
    • Added complete Japanese README with project introduction, key features, setup instructions, and feature comparisons
    • Updated language selectors to include Japanese documentation alongside existing English and Chinese versions

Review Change Stack

@eltociear eltociear requested a review from a team May 17, 2026 13:45
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 17, 2026

📝 Walkthrough

Walkthrough

This PR adds Japanese language support to the OpenHuman project by introducing a new Japanese README (README.ja-JP.md) and updating the language selector links in the English and Simplified Chinese README files to reference the new translation.

Changes

Japanese Localization

Layer / File(s) Summary
Japanese README documentation
README.ja-JP.md
Complete Japanese translation of the OpenHuman README, including project description, features (desktop-first agent, OAuth integrations, Memory Tree storage, voice tools, token compression, messaging), installation instructions from source, workflow comparison with other harnesses, and community contribution links.
Language selector updates
README.md, README.zh-CN.md
Language navigation headers in English and Simplified Chinese READMEs are updated to include a link to the new Japanese README alongside existing language options.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • tinyhumansai/openhuman#1890: Establishes the language-selector navigation pattern that this PR extends by adding the Japanese README link option.

Poem

🐰 A README in Japanese, so bright,
Now OpenHuman speaks in every tongue!
From East to West, the words take flight,
Three languages harmonized as one. ✨

🚥 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 'docs: add Japanese README' directly and concisely summarizes the main change: adding a Japanese translation of the README file.
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: 2

🤖 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`:
- Around line 88-90: The centered <img> element in README.ja-JP.md is missing an
alt attribute (triggering markdownlint MD045); update the <img> tag to include a
short, descriptive alt text in Japanese that describes the image (e.g., for a
project diagram use something like "プロジェクトの図"), ensuring the alt attribute is
present and meaningful for accessibility and linting.
- Around line 48-56: The fenced code block in README.ja-JP.md is missing a
language tag which triggers markdownlint MD040; update the opening
triple-backtick for the shell snippet to include a language tag (e.g., "bash")
so the block becomes ```bash, leaving the contents unchanged; this targets the
code block shown that starts with "# DMG や EXE..." and the two command lines
using curl and irm.
🪄 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: b64784e7-ee6e-47a1-b067-402fef57b973

📥 Commits

Reviewing files that changed from the base of the PR and between f9de38d and 2978736.

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

Comment thread README.ja-JP.md
Comment on lines +48 to +56
```
# DMG や EXE は https://tinyhumans.ai/openhuman からダウンロードするか、ターミナルから実行してください

# macOS または Linux x64 の場合
curl -fsSL https://raw.githubusercontent.com/tinyhumansai/openhuman/main/scripts/install.sh | bash

# Windows の場合
irm https://raw.githubusercontent.com/tinyhumansai/openhuman/main/scripts/install.ps1 | iex
```
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 a language tag to the fenced code block.

This trips markdownlint MD040 and is easy to fix.

Suggested fix
-```
+```bash
 # DMG や EXE は https://tinyhumans.ai/openhuman からダウンロードするか、ターミナルから実行してください
 
 # macOS または Linux x64 の場合
 curl -fsSL https://raw.githubusercontent.com/tinyhumansai/openhuman/main/scripts/install.sh | bash
 
 # Windows の場合
 irm https://raw.githubusercontent.com/tinyhumansai/openhuman/main/scripts/install.ps1 | iex
</details>

<!-- suggestion_start -->

<details>
<summary>📝 Committable suggestion</summary>

> ‼️ **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.

```suggestion

🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 48-48: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🤖 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.ja-JP.md` around lines 48 - 56, The fenced code block in
README.ja-JP.md is missing a language tag which triggers markdownlint MD040;
update the opening triple-backtick for the shell snippet to include a language
tag (e.g., "bash") so the block becomes ```bash, leaving the contents unchanged;
this targets the code block shown that starts with "# DMG や EXE..." and the two
command lines using curl and irm.

Comment thread README.ja-JP.md
Comment on lines +88 to +90
<p align="center">
<img src="./gitbooks/.gitbook/assets/image (1).png" />
</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

Add alt text to the centered image.

The <img> element is missing alt, which hurts accessibility and triggers markdownlint MD045.

Suggested fix
- <img src="./gitbooks/.gitbook/assets/image (1).png" />
+ <img src="./gitbooks/.gitbook/assets/image (1).png" alt="OpenHumanのコンテキスト構築フロー図" />
📝 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="./gitbooks/.gitbook/assets/image (1).png" />
</p>
<p align="center">
<img src="./gitbooks/.gitbook/assets/image (1).png" alt="OpenHumanのコンテキスト構築フロー図" />
</p>
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 89-89: 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.ja-JP.md` around lines 88 - 90, The centered <img> element in
README.ja-JP.md is missing an alt attribute (triggering markdownlint MD045);
update the <img> tag to include a short, descriptive alt text in Japanese that
describes the image (e.g., for a project diagram use something like "プロジェクトの図"),
ensuring the alt attribute is present and meaningful for accessibility and
linting.

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