Skip to content

docs: add Urdu (ur-pk) README translation with RTL support#3387

Merged
senamakel merged 1 commit into
tinyhumansai:mainfrom
AMIK-coorporations:urdu-support-readme-file-AMIK
Jun 4, 2026
Merged

docs: add Urdu (ur-pk) README translation with RTL support#3387
senamakel merged 1 commit into
tinyhumansai:mainfrom
AMIK-coorporations:urdu-support-readme-file-AMIK

Conversation

@AMIK-coorporations
Copy link
Copy Markdown
Contributor

@AMIK-coorporations AMIK-coorporations commented Jun 4, 2026

Summary

  • Add full Urdu (ur-pk) README translation with proper RTL rendering
  • Use <div dir="rtl" lang="ur"> / <div dir="ltr"> switching for mixed Urdu/English content on GitHub
  • Add Urdu اردو shield badge to all 5 existing README translations for consistent cross-linking
  • Language switcher text links to Urdu were already present in all files (added by upstream)

Problem

  • OpenHuman had no Urdu README despite Urdu being one of the most widely spoken languages globally
  • The language switcher already linked to README.ur-pk.md but the shield badges section in all other READMEs was missing the Urdu badge, creating an inconsistency

Solution

  • Created README.ur-pk.md with complete Urdu translation following the same structure as other translations
  • Used HTML <div dir="rtl" lang="ur"> blocks for Urdu text and <div dir="ltr"> blocks for code/badges/images — the standard approach for RTL rendering on GitHub
  • Added lang="ur" attribute to all RTL divs for proper Urdu font selection (Nastaliq/Naskh)
  • Added the Urdu shield badge (اردو) to the badges section of README.md, README.zh-CN.md, README.ja-JP.md, README.ko.md, and README.de.md

Submission Checklist

  • Tests added or updated — N/A: docs-only change, no code modified
  • Diff coverage ≥ 80%N/A: docs-only change
  • Coverage matrix updated — N/A: docs-only change
  • All affected feature IDs listed — N/A: docs-only change
  • No new external network dependencies — N/A: no code changes
  • Manual smoke checklist — N/A: docs-only change
  • Linked issue closed via Closes #NNN

Impact

  • No runtime/platform impact — documentation only
  • No performance, security, migration, or compatibility implications
  • Adds Urdu language accessibility to the project

Related

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

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

  • Key: N/A (human-initiated contribution)
  • URL: N/A

Validation Run

  • pnpm format:checkN/A: only Markdown files changed, no code

Behavior Changes

Summary by CodeRabbit

  • Documentation
    • Added comprehensive Urdu language documentation for the project
    • Updated all README files to include Urdu language option in language selector and badges section

@AMIK-coorporations AMIK-coorporations requested a review from a team June 4, 2026 19:40
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 4, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

This PR adds Urdu (Pakistan) language support to the OpenHuman repository by creating a comprehensive Urdu README and updating language selector links across all existing README files in English, German, Japanese, Korean, and Chinese to include the new Urdu option.

Changes

Urdu Documentation Localization

Layer / File(s) Summary
New Urdu README documentation
README.ur-pk.md
Comprehensive Urdu (Pakistan) README with language selector, installation instructions for macOS, Linux, and Windows, product overview and features, contribution guidelines, comparison table vs other agent harnesses, and community engagement sections.
Language selector updates across READMEs
README.md, README.de.md, README.ja-JP.md, README.ko.md, README.zh-CN.md
All existing README files updated to include Urdu (README.ur-pk.md) in their top-level language selector links and language badge rows for consistent cross-linking.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related issues

Poem

🐰 A fluffy tale in script anew,
Urdu words now welcome too,
From English down to Chinese bright,
Every README shines its light,
Links and badges, all aligned,
Global readers warmly signed!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: add Urdu (ur-pk) README translation with RTL support' clearly and specifically describes the main change: adding a Urdu README translation with RTL support, which matches the PR's primary objective.
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ 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: 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.ur-pk.md`:
- Around line 63-65: The blockquote in README.ur-pk.md is split by a blank line
(MD028) between the lines starting "ابتدائی آزمائشی نسخہ" and "مقامی + منظم
خدمات:"; remove the empty line so the two quoted lines remain contiguous in the
same blockquote (i.e., ensure the "ابتدائی آزمائشی نسخہ" line and the "مقامی +
منظم خدمات:" line are directly adjacent with no blank line between them).
🪄 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: d3717699-29fe-4bb8-a43f-4f6d2912782c

📥 Commits

Reviewing files that changed from the base of the PR and between 769e8ef and 7dc4ab0.

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

Comment thread README.ur-pk.md
Comment on lines +63 to +65
> **ابتدائی آزمائشی نسخہ**: فعال ترقی جاری ہے، بے ضابطگیوں کی توقع کریں۔

> **مقامی + منظم خدمات:** OpenHuman اپنا Memory Tree، Obsidian-style Markdown والٹ، ورک اسپیس کنفیگریشن، اور مقامی رن ٹائم اسٹیٹ آپ کی مشین پر محفوظ کرتا ہے۔ طے شدہ منظم تجربہ اب بھی OpenHuman کی میزبان خدمات استعمال کرتا ہے اکاؤنٹ سائن ان، ماڈل روٹنگ، ویب سرچ پروکسی، اور Composio کنیکٹر پرت کے ذریعے منظم انضمام/OAuth فلو کے لیے۔ اگر آپ اپنا ماڈل، سرچ، یا Composio اسناد لانا چاہتے ہیں تو اپنی مرضی کے مطابق/مقامی سیٹنگز منتخب کریں؛ کچھ ریئل ٹائم ٹرگرز اور میزبان فیچرز اب بھی منظم بیک اینڈ کی ضرورت رکھتے ہیں۔
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot Jun 4, 2026

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 blank line inside the blockquote to avoid markdownlint MD028.

Line 64 breaks the same blockquote into two blocks; keep the quote lines contiguous.

Suggested fix
 > **ابتدائی آزمائشی نسخہ**: فعال ترقی جاری ہے، بے ضابطگیوں کی توقع کریں۔
-
 > **مقامی + منظم خدمات:** OpenHuman اپنا Memory Tree، Obsidian-style Markdown والٹ، ورک اسپیس کنفیگریشن، اور مقامی رن ٹائم اسٹیٹ آپ کی مشین پر محفوظ کرتا ہے۔ طے شدہ منظم تجربہ اب بھی OpenHuman کی میزبان خدمات استعمال کرتا ہے اکاؤنٹ سائن ان، ماڈل روٹنگ، ویب سرچ پروکسی، اور Composio کنیکٹر پرت کے ذریعے منظم انضمام/OAuth فلو کے لیے۔ اگر آپ اپنا ماڈل، سرچ، یا Composio اسناد لانا چاہتے ہیں تو اپنی مرضی کے مطابق/مقامی سیٹنگز منتخب کریں؛ کچھ ریئل ٹائم ٹرگرز اور میزبان فیچرز اب بھی منظم بیک اینڈ کی ضرورت رکھتے ہیں۔
📝 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
> **ابتدائی آزمائشی نسخہ**: فعال ترقی جاری ہے، بے ضابطگیوں کی توقع کریں۔
> **مقامی + منظم خدمات:** OpenHuman اپنا Memory Tree، Obsidian-style Markdown والٹ، ورک اسپیس کنفیگریشن، اور مقامی رن ٹائم اسٹیٹ آپ کی مشین پر محفوظ کرتا ہے۔ طے شدہ منظم تجربہ اب بھی OpenHuman کی میزبان خدمات استعمال کرتا ہے اکاؤنٹ سائن ان، ماڈل روٹنگ، ویب سرچ پروکسی، اور Composio کنیکٹر پرت کے ذریعے منظم انضمام/OAuth فلو کے لیے۔ اگر آپ اپنا ماڈل، سرچ، یا Composio اسناد لانا چاہتے ہیں تو اپنی مرضی کے مطابق/مقامی سیٹنگز منتخب کریں؛ کچھ ریئل ٹائم ٹرگرز اور میزبان فیچرز اب بھی منظم بیک اینڈ کی ضرورت رکھتے ہیں۔
> **ابتدائی آزمائشی نسخہ**: فعال ترقی جاری ہے، بے ضابطگیوں کی توقع کریں۔
> **مقامی + منظم خدمات:** OpenHuman اپنا Memory Tree، Obsidian-style Markdown والٹ، ورک اسپیس کنفیگریشن، اور مقامی رن ٹائم اسٹیٹ آپ کی مشین پر محفوظ کرتا ہے۔ طے شدہ منظم تجربہ اب بھی OpenHuman کی میزبان خدمات استعمال کرتا ہے اکاؤنٹ سائن ان، ماڈل روٹنگ، ویب سرچ پروکسی، اور Composio کنیکٹر پرت کے ذریعے منظم انضمام/OAuth فلو کے لیے۔ اگر آپ اپنا ماڈل، سرچ، یا Composio اسناد لانا چاہتے ہیں تو اپنی مرضی کے مطابق/مقامی سیٹنگز منتخب کریں؛ کچھ ریئل ٹائم ٹرگرز اور میزبان فیچرز اب بھی منظم بیک اینڈ کی ضرورت رکھتے ہیں۔
🧰 Tools
🪛 LanguageTool

[whitespace] ~63-~63: آیا منظور شما «"نسخه"» است؟
Context: ...r="rtl" lang="ur"> > ابتدائی آزمائشی نسخہ: فعال ترقی جاری ہے، بے ضابطگیوں کی تو...

(ReplaceLettersInSameLangs)


[whitespace] ~63-~63: آیا منظور شما «"هے"» است؟
Context: ...ابتدائی آزمائشی نسخہ*: فعال ترقی جاری ہے، بے ضابطگیوں کی توقع کریں۔ > **مقامی +...

(ReplaceLettersInSameLangs)


[whitespace] ~65-~65: آیا منظور شما «"هے۔"» است؟
Context: ... رن ٹائم اسٹیٹ آپ کی مشین پر محفوظ کرتا ہے۔ طے شدہ منظم تجربہ اب بھی OpenHuman کی م...

(ReplaceLettersInSameLangs)


[whitespace] ~65-~65: آیا منظور شما «"شده"» است؟
Context: ...م اسٹیٹ آپ کی مشین پر محفوظ کرتا ہے۔ طے شدہ منظم تجربہ اب بھی OpenHuman کی میزبان خ...

(ReplaceLettersInSameLangs)


[whitespace] ~65-~65: آیا منظور شما «"تجربه"» است؟
Context: ...پ کی مشین پر محفوظ کرتا ہے۔ طے شدہ منظم تجربہ اب بھی OpenHuman کی میزبان خدمات استعما...

(ReplaceLettersInSameLangs)


[whitespace] ~65-~65: آیا منظور شما «"بهی"» است؟
Context: ... پر محفوظ کرتا ہے۔ طے شدہ منظم تجربہ اب بھی OpenHuman کی میزبان خدمات استعمال کرتا ...

(ReplaceLettersInSameLangs)


[whitespace] ~65-~65: آیا منظور شما «"هے"» است؟
Context: ... OpenHuman کی میزبان خدمات استعمال کرتا ہے اکاؤنٹ سائن ان، ماڈل روٹنگ، ویب سرچ پرو...

(ReplaceLettersInSameLangs)


[whitespace] ~65-~65: آیا منظور شما «"چاهتے"» است؟
Context: ... اپنا ماڈل، سرچ، یا Composio اسناد لانا چاہتے ہیں تو اپنی مرضی کے مطابق/مقامی سیٹنگز ...

(ReplaceLettersInSameLangs)


[whitespace] ~65-~65: آیا منظور شما «"هیں"» است؟
Context: ...ماڈل، سرچ، یا Composio اسناد لانا چاہتے ہیں تو اپنی مرضی کے مطابق/مقامی سیٹنگز منتخ...

(ReplaceLettersInSameLangs)


[whitespace] ~65-~65: آیا منظور شما «"کچه"» است؟
Context: ... مرضی کے مطابق/مقامی سیٹنگز منتخب کریں؛ کچھ ریئل ٹائم ٹرگرز اور میزبان فیچرز اب بھی...

(ReplaceLettersInSameLangs)


[whitespace] ~65-~65: آیا منظور شما «"بهی"» است؟
Context: ...کچھ ریئل ٹائم ٹرگرز اور میزبان فیچرز اب بھی منظم بیک اینڈ کی ضرورت رکھتے ہیں۔ # ان...

(ReplaceLettersInSameLangs)


[whitespace] ~65-~65: آیا منظور شما «"رکهتے"» است؟
Context: ...بان فیچرز اب بھی منظم بیک اینڈ کی ضرورت رکھتے ہیں۔ # انسٹال کریں انسٹالر [tinyhuman...

(ReplaceLettersInSameLangs)


[whitespace] ~65-~65: آیا منظور شما «"هیں۔"» است؟
Context: ...چرز اب بھی منظم بیک اینڈ کی ضرورت رکھتے ہیں۔ # انسٹال کریں انسٹالر [tinyhumans.ai/...

(ReplaceLettersInSameLangs)

🪛 markdownlint-cli2 (0.22.1)

[warning] 64-64: Blank line inside blockquote

(MD028, no-blanks-blockquote)

🤖 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.ur-pk.md` around lines 63 - 65, The blockquote in README.ur-pk.md is
split by a blank line (MD028) between the lines starting "ابتدائی آزمائشی نسخہ"
and "مقامی + منظم خدمات:"; remove the empty line so the two quoted lines remain
contiguous in the same blockquote (i.e., ensure the "ابتدائی آزمائشی نسخہ" line
and the "مقامی + منظم خدمات:" line are directly adjacent with no blank line
between them).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

This blank because of our language style

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.

@AMIK-coorporations, understood — keeping the blank line as a deliberate stylistic separation between the two notes is perfectly fine. Just be aware that markdownlint will continue to flag it as MD028. If you'd like to suppress that warning, you can add a .markdownlintrc or inline comment to ignore it, but it's entirely optional for a documentation-only file.

(ᵔᴥᵔ)


🧠 Learnings used
Learnt from: CR
Repo: tinyhumansai/openhuman PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-05-05T18:16:07.997Z
Learning: Always create PRs against **[tinyhumansai/openhuman](https://github.com/tinyhumansai/openhuman)** ([pull requests](https://github.com/tinyhumansai/openhuman/pulls)), not only a fork's default remote. Use [`.github/PULL_REQUEST_TEMPLATE.md`](.github/PULL_REQUEST_TEMPLATE.md); AI-generated PR text should follow its sections and checklist.

Learnt from: senamakel
Repo: tinyhumansai/openhuman PR: 2208
File: app/src/lib/i18n/chunks/ar-3.ts:204-206
Timestamp: 2026-05-20T04:29:21.052Z
Learning: In the tinyhumansai/openhuman repository, new i18n translation keys added to non-English locale chunks (e.g., ar-3.ts, bn-3.ts, es-3.ts, etc.) intentionally use English string values as placeholders until a native-speaker review can be completed. This is an accepted pattern; do not flag untranslated strings in non-English locale files as blocking issues — they are deferred to follow-up PRs by design.

Learnt from: senamakel
Repo: tinyhumansai/openhuman PR: 2208
File: app/src/lib/i18n/chunks/id-3.ts:211-214
Timestamp: 2026-05-20T04:30:03.658Z
Learning: In the tinyhumansai/openhuman repository, new i18n translation keys added to non-English locale chunks (e.g., id-3.ts, ar-1.ts, bn-3.ts, es-3.ts, fr-3.ts, hi-3.ts, it-3.ts, ko-3.ts, pt-3.ts, ru-3.ts, zh-CN-3.ts) are intentionally shipped with English fallback values first. Native-speaker translation is handled separately as a follow-up and is explicitly out of scope for the originating PR. Do not flag untranslated non-English locale entries as issues in PRs for this project.

Learnt from: senamakel
Repo: tinyhumansai/openhuman PR: 2208
File: app/src/lib/i18n/chunks/ar-3.ts:207-210
Timestamp: 2026-05-20T04:29:49.863Z
Learning: In the tinyhumansai/openhuman repository, new i18n keys added to non-English locale chunks (e.g., ar-3.ts, bn-3.ts, es-3.ts, fr-3.ts, hi-3.ts, etc.) intentionally use English fallback strings when native-speaker translations are not yet available. Translating non-English locales requires native-speaker review and is deferred to follow-up PRs; do not flag untranslated non-English locale entries as issues during PR review.

Learnt from: CR
Repo: tinyhumansai/openhuman PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-06-03T03:23:47.354Z
Learning: Applies to src/openhuman/about_app/**/*.rs : Update `src/openhuman/about_app/` (capability catalog) when a change adds, removes, renames, relocates, or materially changes a user-facing feature.

Learnt from: senamakel
Repo: tinyhumansai/openhuman PR: 2208
File: app/src/lib/i18n/chunks/hi-3.ts:210-213
Timestamp: 2026-05-20T04:29:59.550Z
Learning: In the `tinyhumansai/openhuman` repository, new i18n keys added to non-English locale chunks (e.g., `hi-3.ts`, `ar-3.ts`, `bn-3.ts`, etc.) intentionally use English fallback strings when the corresponding native translations are not yet available. Native-speaker review is handled separately as a follow-up and is considered out of scope for the PR that introduces the feature.

Learnt from: senamakel
Repo: tinyhumansai/openhuman PR: 2208
File: app/src/lib/i18n/chunks/hi-1.ts:83-84
Timestamp: 2026-05-20T04:29:31.004Z
Learning: In the `tinyhumansai/openhuman` repository, new i18n translation keys added to non-English locale chunk files (e.g., `app/src/lib/i18n/chunks/hi-1.ts`, `ar-1.ts`, `bn-1.ts`, etc.) intentionally use English string values as fallbacks. Actual non-English translations require native-speaker review and are handled in separate follow-up PRs. Do not flag untranslated non-English locale strings as issues in this repo.

Learnt from: CR
Repo: tinyhumansai/openhuman PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-06-03T03:23:47.354Z
Learning: Applies to src/openhuman/about_app/**/*.rs : When a change adds, removes, renames, relocates, or materially changes a user-facing feature, update `src/openhuman/about_app/` in the same work so the runtime capability catalog remains the source of truth

Learnt from: CR
Repo: tinyhumansai/openhuman PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-06-03T03:23:47.354Z
Learning: Applies to src/openhuman/about_app/**/*.rs : When a change adds, removes, renames, relocates, or materially changes a user-facing feature, update src/openhuman/about_app/ in the same work so the runtime capability catalog remains the source of truth

Learnt from: CR
Repo: tinyhumansai/openhuman PR: 0
File: AGENTS.md:0-0
Timestamp: 2026-06-03T05:05:50.773Z
Learning: Applies to src/openhuman/about_app/**/*.rs : When a change adds, removes, renames, relocates, or materially changes a user-facing feature, update `src/openhuman/about_app/` in the same work so the capability catalog remains the source of truth

Learnt from: senamakel
Repo: tinyhumansai/openhuman PR: 2208
File: app/src/lib/i18n/chunks/bn-3.ts:208-210
Timestamp: 2026-05-20T04:29:23.910Z
Learning: In the tinyhumansai/openhuman repository, new i18n keys added to non-English locale chunks (e.g. bn-3.ts, ar-3.ts, es-3.ts, etc.) intentionally use English fallback strings when native-speaker translations are not yet available. This is a deliberate project convention; do not flag untranslated strings in non-English locale chunk files as issues, as translations are tracked as separate follow-up work requiring native-speaker review.

Learnt from: senamakel
Repo: tinyhumansai/openhuman PR: 1991
File: docs/wechat-message-scraping-issue.md:29-29
Timestamp: 2026-05-17T09:24:59.313Z
Learning: When reviewing Markdown (.md), do not treat lowercase ".github" as a capitalization mistake when it appears in file path references inside links or parentheses (e.g., ".github/workflows/foo.yml"). Treat the ".github" directory name as a case-sensitive path convention; suggesting ".GitHub" would break links on case-sensitive filesystems. Only flag casing when it affects actual prose text (e.g., incorrectly written “GitHub”) rather than filesystem paths.

@senamakel senamakel merged commit 7edfb04 into tinyhumansai:main Jun 4, 2026
28 of 34 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.

Add Urdu language support with strict LTR directionality for README and app UI

2 participants