Skip to content

docs: add German translation (README.de.md) and update language switcher#2160

Merged
senamakel merged 3 commits into
tinyhumansai:mainfrom
flitzrrr:docs/de-readme-translation
May 19, 2026
Merged

docs: add German translation (README.de.md) and update language switcher#2160
senamakel merged 3 commits into
tinyhumansai:mainfrom
flitzrrr:docs/de-readme-translation

Conversation

@flitzrrr
Copy link
Copy Markdown
Contributor

@flitzrrr flitzrrr commented May 18, 2026

Summary

Problem

  • The repo ships READMEs for en / zh-CN / ja-JP / ko, but no German version. Deutsch is missing from the language switchers as well, so German-speaking visitors have no entry point and the existing localized READMEs don't reference each other consistently.

Solution

  • Translated README.md verbatim into German: every link, badge, image, code block, comparison-table cell and section heading preserved. Real umlauts (ä, ö, ü, ß) throughout. Product names (OpenHuman, Memory Tree, TokenJuice, Auto-Fetch, OpenClaw, Hermes Agent, agentmemory) and CLI commands left in English.
  • Updated all four existing READMEs so the language selector and shield badges link to README.de.md.
  • Follow-up commits addressed CodeRabbit feedback on README.de.md:
    • f97728bc — added bash language hint to the install fenced code block and alt="Diagramm zum OpenHuman-Kontextaufbau" to the context-diagram image.
    • e91c83e8 — added the lang-Deutsch-blue self-badge in the language-badge row, mirroring the pattern from README.ko.md.
  • The same bash-fence and image-alt markdown-lint findings still exist in README.md, README.ja-JP.md and README.ko.md — left untouched here to keep this PR scoped to the German translation. Will be tracked separately.

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

  • Improves accessibility for German-speaking developers and contributors.
  • No runtime, platform, performance, security or migration impact.

Related

  • Closes: N/A
  • Follow-up PR(s)/TODOs: markdown-lint cleanup (missing bash fence + missing image alt) for README.md, README.ja-JP.md and README.ko.md — to be tracked in a separate issue.

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: docs/de-readme-translation
  • Commit SHA: e91c83e8

Validation Run

  • pnpm --filter openhuman-app format:check: N/A — touched files are root-level READMEs and live outside the app/ Prettier scope (verified via app/.prettierignore).
  • pnpm typecheck: N/A (no code changes)
  • Focused tests: N/A (no code changes)
  • Rust fmt/check (if changed): N/A
  • Tauri fmt/check (if changed): N/A

Validation Blocked

  • command: N/A
  • error: N/A
  • impact: N/A

Behavior Changes

  • Intended behavior change: Documentation parity for German users.
  • User-visible effect: Users can now read the README in German and switch into/out of it from the other three localized READMEs.

Parity Contract

  • Legacy behavior preserved: Yes — the four existing READMEs each gained a single switcher entry and a single badge; no other copy was changed.
  • Guard/fallback/dispatch parity checks: N/A

Duplicate / Superseded PR Handling

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

Summary by CodeRabbit

  • Documentation
    • Published a full German landing-style README with installation guides (macOS/Linux/Windows), feature overview, contributor setup, onboarding note, comparison table, and contributors gallery.
    • Added the German language option and badge across the English, Japanese, Korean, and Chinese READMEs.

Review Change Stack

- Adds README.de.md, modeled on README.ko.md (tinyhumansai#2043) and README.zh-CN.md (tinyhumansai#1890).

- Extends the language switcher and the lang-badge row in README.md, README.zh-CN.md, README.ja-JP.md and README.ko.md to include Deutsch.
@flitzrrr flitzrrr requested a review from a team May 18, 2026 21:40
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 18, 2026

📝 Walkthrough

Walkthrough

This PR adds German language support by introducing a full German landing README (README.de.md) and updating the language selector and language badges in the root and localized READMEs to link to the new German documentation.

Changes

German Documentation and Language Navigation

Layer / File(s) Summary
German README branding and navigation
README.de.md
Establishes the German README top section with language switcher, title, demo image, and status badges including a “Frühe Beta” notice.
German README installation and onboarding
README.de.md
Adds platform-specific installation commands and onboarding entry points (macOS/Linux shell, Windows PowerShell) and transitions into the product description.
German README features and contributor setup
README.de.md
Documents "Was ist OpenHuman?" feature bullets and provides contributor setup/checklist linking to contributing and architecture docs.
Onboarding narrative and technical context
README.de.md
Adds the "Kontext in Minuten, nicht in Wochen" narrative with images and backend/config references for rapid sync/compression/on-device context flow.
Comparison table and community engagement
README.de.md
Adds a feature comparison table versus other agent harnesses, GitHub star prompt with Star History embed, and a Contributors Hall of Fame section.
Language selector and badge updates across translations
README.md, README.ja-JP.md, README.ko.md, README.zh-CN.md
Updates language navigation links and language badges in the root and localized READMEs to include a Deutsch option linking to README.de.md.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

Suggested reviewers

  • senamakel

Poem

🐰 A German whisper joins our choir, acht languages now inspire,
From Deutsch to 日本語, the README climbs higher,
Auf Wiedersehen, English walls—OpenHuman rings the call,
New links and badges spread the word to one and all! 🌍✨

🚥 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 clearly describes the main changes: adding a German README translation and updating language switchers across documentation 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: 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.de.md`:
- Line 91: Add a descriptive alt attribute to the image tag so it’s accessible
and satisfies markdown linting; update the <img
src="./gitbooks/.gitbook/assets/image (1).png" /> element to include a
meaningful alt value (e.g., alt="Screenshot of ...", or alt="Diagram showing
...") that accurately describes the image content.
- Around line 50-58: The fenced code block in README.de.md lacks a language
identifier; update the opening fence from ``` to ```bash so the install snippet
declares the shell language (e.g., change the triple backticks that start the
block to ```bash) to satisfy linting and improve rendering.
🪄 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: 56b6e56a-302d-408f-94a0-da562cead5c8

📥 Commits

Reviewing files that changed from the base of the PR and between 0b053c5 and a673280.

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

Comment thread README.de.md Outdated
Comment thread README.de.md Outdated
@flitzrrr
Copy link
Copy Markdown
Contributor Author

@coderabbitai Applied your two findings to README.de.md in commit f97728b:

  • Code fence at the install snippet now declares bash.
  • The context-diagram image gained alt="Diagramm zum OpenHuman-Kontextaufbau".

The same two markdown-lint findings exist in README.md, README.ja-JP.md and README.ko.md (only README.zh-CN.md was already fixed). Left untouched here to keep this PR scoped to the German translation — happy to open a separate cleanup PR for the other three locales if @senamakel wants them aligned.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 18, 2026

Tip

For best results, initiate chat on the files or code changes.

@flitzrrr Thanks for the clean follow-up — both fixes look exactly right:

  • ```bash on the install snippet removes the fenced-code-language lint warning.
  • The alt="Diagramm zum OpenHuman-Kontextaufbau" attribute satisfies the accessibility/lint requirement for the context diagram.

The scoping rationale makes sense; keeping the cleanup for the other three locales in a dedicated PR will make the diff easier to review. Would you like me to open a GitHub issue now to track the markdown-lint alignment for README.md, README.ja-JP.md, and README.ko.md? That way @senamakel has a concrete ticket to point to, and nothing slips through.

(´。• ᵕ •。`) ♡

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: 1

🤖 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.de.md`:
- Around line 40-44: Add the missing Deutsch language badge to the language
badges row by inserting a badge link for README.de.md using the same pattern as
the others (e.g., <a href="./README.de.md"><img
src="https://img.shields.io/badge/lang-Deutsch-blue" alt="Deutsch" /></a>)
placed after the existing badges so the language switcher row includes Deutsch;
update the badge row in README.de.md near the other <a href="..."> badge
elements (the block containing links to README.md, README.zh-CN.md,
README.ja-JP.md, README.ko.md).
🪄 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: 1712aa59-0542-4747-8b64-e4a3396c72b9

📥 Commits

Reviewing files that changed from the base of the PR and between a673280 and f97728b.

📒 Files selected for processing (1)
  • README.de.md

Comment thread README.de.md
@flitzrrr
Copy link
Copy Markdown
Contributor Author

@coderabbitai Added the lang-Deutsch-blue self-badge to README.de.md in commit e91c83e — the language-badge row in this file now mirrors the pattern from README.ko.md.

And yes please, go ahead and open the GitHub issue tracking the markdown-lint alignment (missing bash fence + missing image alt) for README.md, README.ja-JP.md and README.ko.md. That'll keep the cleanup discoverable for @senamakel without bloating this PR.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 18, 2026

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

On it! Creating the tracking issue now.


🏁 Script executed:

gh issue create \
  --repo tinyhumansai/openhuman \
  --title "docs: fix markdown-lint warnings in README.md, README.ja-JP.md, and README.ko.md (missing bash fence + missing image alt)" \
  --body "## Summary

Three locale READMEs still have two markdown-lint findings that were already fixed in \`README.de.md\` (PR `#2160`, commit f97728bc) and \`README.zh-CN.md\`:

| Finding | Affected files |
|---|---|
| Fenced code block missing language hint (\`bash\`) on the install snippet | \`README.md\`, \`README.ja-JP.md\`, \`README.ko.md\` |
| Context-diagram \`<img>\` tag missing \`alt\` attribute | \`README.md\`, \`README.ja-JP.md\`, \`README.ko.md\` |

## Background

Spotted during review of PR `#2160` (German README translation). To keep that PR scoped to the new translation, the cleanup for the other locales was intentionally deferred to a dedicated PR.

## Requested fix

For each of the three files:
1. Add \`bash\` as the language hint to the fenced install-script code block.
2. Add a descriptive \`alt\` attribute to the context-diagram \`<img>\` tag (following the pattern used in \`README.de.md\`: \`alt=\"Diagramm zum OpenHuman-Kontextaufbau\"\` — localised equivalents preferred).

## References

- PR `#2160` — German README (fixes applied to \`README.de.md\`)
- Raised by `@flitzrrr`
" \
  --assignee flitzrrr

Length of output: 77


The assignee couldn't be set automatically — retrying without it.


🏁 Script executed:

gh issue create \
  --repo tinyhumansai/openhuman \
  --title "docs: fix markdown-lint warnings in README.md, README.ja-JP.md, and README.ko.md (missing bash fence + missing image alt)" \
  --body "## Summary

Three locale READMEs still have two markdown-lint findings that were already fixed in \`README.de.md\` (PR `#2160`, commit f97728bc) and \`README.zh-CN.md\`:

| Finding | Affected files |
|---|---|
| Fenced code block missing language hint (\`bash\`) on the install snippet | \`README.md\`, \`README.ja-JP.md\`, \`README.ko.md\` |
| Context-diagram \`<img>\` tag missing \`alt\` attribute | \`README.md\`, \`README.ja-JP.md\`, \`README.ko.md\` |

## Background

Spotted during review of PR `#2160` (German README translation). To keep that PR scoped to the new translation, the cleanup for the other locales was intentionally deferred to a dedicated PR.

## Requested fix

For each of the three files:
1. Add \`bash\` as the language hint to the fenced install-script code block.
2. Add a descriptive \`alt\` attribute to the context-diagram \`<img>\` tag (following the pattern used in \`README.de.md\`: \`alt=\"Diagramm zum OpenHuman-Kontextaufbau\"\` — localised equivalents preferred).

## References

- PR `#2160` — German README (fixes applied to \`README.de.md\`)
- Raised by `@flitzrrr`
"

Length of output: 54


@flitzrrr The tracking issue is live: #2162

It covers both lint findings (missing bash fence + missing image alt) for README.md, README.ja-JP.md, and README.ko.md, with a backlink to this PR. @senamakel can use it to schedule or assign the cleanup PR whenever convenient.

And nice touch adding the lang-Deutsch-blue self-badge — the badge row in README.de.md is now fully consistent with the other locales. This PR looks good to go! 🐇 ✨

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.

🧹 Nitpick comments (1)
README.de.md (1)

8-8: ⚡ Quick win

Consider using German alt text for consistency.

The main demo image uses English alt text "The Tet" while the rest of the README is in German. For consistency with the German localization, consider using a descriptive German alt attribute.

💬 Suggested improvement
-  <img src="./gitbooks/.gitbook/assets/demo.png" alt="The Tet" />
+  <img src="./gitbooks/.gitbook/assets/demo.png" alt="OpenHuman Demo-Screenshot" />

Or if "The Tet" is a proper name for the mascot/character, consider clarifying: alt="The Tet – OpenHuman Demo"

🤖 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.de.md` at line 8, Update the img tag with src
"./gitbooks/.gitbook/assets/demo.png" that currently has alt="The Tet" to use a
German alt attribute (e.g., alt="Das Tet – OpenHuman Demo" or a descriptive
German phrase) for consistency with the German README, or if "The Tet" is a
proper name, include both languages in the alt text (e.g., alt="The Tet –
OpenHuman Demo / Das Tet – OpenHuman Demo").
🤖 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.

Nitpick comments:
In `@README.de.md`:
- Line 8: Update the img tag with src "./gitbooks/.gitbook/assets/demo.png" that
currently has alt="The Tet" to use a German alt attribute (e.g., alt="Das Tet –
OpenHuman Demo" or a descriptive German phrase) for consistency with the German
README, or if "The Tet" is a proper name, include both languages in the alt text
(e.g., alt="The Tet – OpenHuman Demo / Das Tet – OpenHuman Demo").

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 4f994d8f-5e36-4a75-90cc-b70a58adf036

📥 Commits

Reviewing files that changed from the base of the PR and between f97728b and e91c83e.

📒 Files selected for processing (1)
  • README.de.md

@senamakel senamakel merged commit f0b7233 into tinyhumansai:main May 19, 2026
27 of 29 checks passed
mtkik pushed a commit to mtkik/openhuman-meet that referenced this pull request May 21, 2026
CodeGhost21 pushed a commit to CodeGhost21/openhuman that referenced this pull request May 22, 2026
AusAgentSmith pushed a commit to AusAgentSmith/openhuman that referenced this pull request May 23, 2026
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