[GH-ISSUE #2937] [Docs] Add Hindi (हिन्दी) README and website translations #1034

Open
opened 2026-10-15 18:30:31 +00:00 by bsakaguchi · 7 comments
Owner

Originally created by @ShivekRanjan on GitHub (Oct 13, 2026).
Original GitHub issue: https://github.com/morluto/rea/issues/2937

Before submitting

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

Documentation location

README.md language bar, docs/readme/, website/locales/languages.json

Problem

REA has 18 translated README and website editions, but none in an Indian language, so Hindi readers have no edition to choose from the README language bar or the rea.tools language picker.

The multilingual website work in #1022 (completed in #1779) gave every README edition a matching website edition, so Hindi can use that existing infrastructure without changing the localization system. I'd like to add it and translate it myself as a native Hindi reader.

Expected content

A Hindi (hi) edition, added the same way as the existing translations:

  • docs/readme/README_hi.md, linked from every README language bar
  • hi in website/locales/languages.json and a website/locales/hi/messages.po catalog covering the current English website
  • A Devanagari font stack and normal letter-spacing for :lang(hi) in website/public/assets/styles.css. The existing language rules cover only Chinese, Japanese, Korean, Thai and right-to-left scripts.
  • tests/conformance/readmeConsistency.test.ts updated from 18 to 19 translated editions

Commands, code blocks, links, product names and evidence would stay unchanged, following website/locales/README.md.

Supporting evidence

website/locales/languages.json lists 18 translations and no hi entry. tests/conformance/readmeConsistency.test.ts expects exactly 18 translated READMEs.

Additional context

Two questions before I start:

  1. Would you prefer one PR, or the README first and the website catalog in a follow-up? The README and website editions are registered together in languages.json, so the first PR would need at least the registration.
  2. Are hi and the native name हिन्दी the right language code and label?

Related: #1022, #1779

Originally created by @ShivekRanjan on GitHub (Oct 13, 2026). Original GitHub issue: https://github.com/morluto/rea/issues/2937 ### 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 README.md language bar, docs/readme/, website/locales/languages.json ### Problem REA has 18 translated README and website editions, but none in an Indian language, so Hindi readers have no edition to choose from the README language bar or the rea.tools language picker. The multilingual website work in #1022 (completed in #1779) gave every README edition a matching website edition, so Hindi can use that existing infrastructure without changing the localization system. I'd like to add it and translate it myself as a native Hindi reader. ### Expected content A Hindi (`hi`) edition, added the same way as the existing translations: - `docs/readme/README_hi.md`, linked from every README language bar - `hi` in `website/locales/languages.json` and a `website/locales/hi/messages.po` catalog covering the current English website - A Devanagari font stack and normal letter-spacing for `:lang(hi)` in `website/public/assets/styles.css`. The existing language rules cover only Chinese, Japanese, Korean, Thai and right-to-left scripts. - `tests/conformance/readmeConsistency.test.ts` updated from 18 to 19 translated editions Commands, code blocks, links, product names and evidence would stay unchanged, following `website/locales/README.md`. ### Supporting evidence `website/locales/languages.json` lists 18 translations and no `hi` entry. `tests/conformance/readmeConsistency.test.ts` expects exactly 18 translated READMEs. ### Additional context Two questions before I start: 1. Would you prefer one PR, or the README first and the website catalog in a follow-up? The README and website editions are registered together in `languages.json`, so the first PR would need at least the registration. 2. Are `hi` and the native name `हिन्दी` the right language code and label? Related: #1022, #1779
Author
Owner

@uyg7x commented on GitHub (Oct 13, 2026):

Hey @ShivekRanjan, great initiative here. I'm actually building tools for the Indian market right now too, so this is right up my alley.
You're absolutely right about using hi and हिन्दी.
Since you're already planning to handle the translations, want to split the work? I can take care of the technical wiring (updating languages.json, bumping the test count to 19, and adding the Devanagari font stack to the CSS). That way, you can focus purely on the Hindi text for the README and .po files.
We can co-author the PR so you get full credit for the translation. Let me know if that works for you.

<!-- gh-comment-id:6152078656 --> @uyg7x commented on GitHub (Oct 13, 2026): Hey @ShivekRanjan, great initiative here. I'm actually building tools for the Indian market right now too, so this is right up my alley. You're absolutely right about using hi and हिन्दी. Since you're already planning to handle the translations, want to split the work? I can take care of the technical wiring (updating languages.json, bumping the test count to 19, and adding the Devanagari font stack to the CSS). That way, you can focus purely on the Hindi text for the README and .po files. We can co-author the PR so you get full credit for the translation. Let me know if that works for you.
Author
Owner

@ShivekRanjan commented on GitHub (Oct 13, 2026):

@uyg7x Sounds good, happy to split it. Here's how I'd suggest we do it:

  • I'll open the final PR from the docs/hindi branch on my fork, since it's tied to this issue and most of the diff will be translation.
  • You take the wiring: languages.json, the README language bars, the Devanagari font stack in the CSS, and the language test count. Please open a PR against my docs/hindi branch and I'll merge it in, so your commits stay under your name. I'll also make sure you're credited as co-author on the final PR.
  • I'll do docs/readme/README_hi.md and the website catalog. Once your wiring is in, I'll run website.py sync and translations extract to generate website/locales/hi/messages.po and translate it.

Two things before we start:

  1. Let's wait for a maintainer on the one-PR-vs-two question and on hi / हिन्दी. If they want the README and website as separate PRs, the wiring may need to split the same way.
  2. #2142 (Bangla) touches the same files. The test count is 19 if we merge first and 20 if #2142 does, and the language bars need both languages either way.

I've also sketched the wiring locally, so I can push it to the branch as a starting point if that saves you time. Otherwise I'll leave it to you.

<!-- gh-comment-id:6152578167 --> @ShivekRanjan commented on GitHub (Oct 13, 2026): @uyg7x Sounds good, happy to split it. Here's how I'd suggest we do it: - I'll open the final PR from the [`docs/hindi`](https://github.com/ShivekRanjan/rea/tree/docs/hindi) branch on my fork, since it's tied to this issue and most of the diff will be translation. - You take the wiring: `languages.json`, the README language bars, the Devanagari font stack in the CSS, and the language test count. Please open a PR against my `docs/hindi` branch and I'll merge it in, so your commits stay under your name. I'll also make sure you're credited as co-author on the final PR. - I'll do `docs/readme/README_hi.md` and the website catalog. Once your wiring is in, I'll run `website.py sync` and `translations extract` to generate `website/locales/hi/messages.po` and translate it. Two things before we start: 1. Let's wait for a maintainer on the one-PR-vs-two question and on `hi` / `हिन्दी`. If they want the README and website as separate PRs, the wiring may need to split the same way. 2. #2142 (Bangla) touches the same files. The test count is 19 if we merge first and 20 if #2142 does, and the language bars need both languages either way. I've also sketched the wiring locally, so I can push it to the branch as a starting point if that saves you time. Otherwise I'll leave it to you.
Author
Owner

@uyg7x commented on GitHub (Oct 13, 2026):

@ShivekRanjan
Go ahead and push your sketch to the docs/hindi branch — that’ll definitely save time, and I can just pick it up from there.
I completely agree on waiting for the maintainer's call on the 1 vs 2 PR setup, and keeping an eye on the Bangla PR #2142 so we get the test count right (19 vs 20).
Just drop a reply here once your branch is pushed, and I'll hold tight until the maintainer gives the green light.

<!-- gh-comment-id:6152734253 --> @uyg7x commented on GitHub (Oct 13, 2026): @ShivekRanjan Go ahead and push your sketch to the docs/hindi branch — that’ll definitely save time, and I can just pick it up from there. I completely agree on waiting for the maintainer's call on the 1 vs 2 PR setup, and keeping an eye on the Bangla PR #2142 so we get the test count right (19 vs 20). Just drop a reply here once your branch is pushed, and I'll hold tight until the maintainer gives the green light.
Author
Owner

@ShivekRanjan commented on GitHub (Oct 13, 2026):

@uyg7x Pushed. docs/hindi now has the wiring in one commit: hi in languages.json, हिन्दी in all the README language bars, the Devanagari font stack, the README count bumped to 19, and an untranslated README_hi.md template. npm run docs:check passes on it.

Could you review it, especially the Devanagari font stack and spacing in styles.css? And if #2142 merges before us, the count needs to go to 20 and the bars need বাংলা added. It'd be great if you could pick that up when it happens.

Agreed on holding until the maintainer weighs in.

<!-- gh-comment-id:6153012342 --> @ShivekRanjan commented on GitHub (Oct 13, 2026): @uyg7x Pushed. [`docs/hindi`](https://github.com/ShivekRanjan/rea/tree/docs/hindi) now has the wiring in one commit: `hi` in `languages.json`, हिन्दी in all the README language bars, the Devanagari font stack, the README count bumped to 19, and an untranslated `README_hi.md` template. `npm run docs:check` passes on it. Could you review it, especially the Devanagari font stack and spacing in `styles.css`? And if #2142 merges before us, the count needs to go to 20 and the bars need বাংলা added. It'd be great if you could pick that up when it happens. Agreed on holding until the maintainer weighs in.
Author
Owner

@ShivekRanjan commented on GitHub (Oct 14, 2026):

I just noticed #2862, opened before this issue, already adds a Hindi README, so I'll stop on the README to avoid duplicating it.

Two things it doesn't cover yet, which I'd be glad to take as follow-ups once it merges:

  • the website catalog: website/locales/hi/messages.po is still 0 / 1,594 translated, so every Hindi page falls back to English
  • a Devanagari font stack and spacing for :lang(hi) in styles.css

@rollroyces I'm also happy to review the Hindi in #2862 if that helps.

@uyg7x this changes our plan: the wiring will come from #2862, so there's no need to rebuild docs/hindi. Once #2862 merges, we could split the catalog between us.

<!-- gh-comment-id:6164897931 --> @ShivekRanjan commented on GitHub (Oct 14, 2026): I just noticed #2862, opened before this issue, already adds a Hindi README, so I'll stop on the README to avoid duplicating it. Two things it doesn't cover yet, which I'd be glad to take as follow-ups once it merges: - the website catalog: `website/locales/hi/messages.po` is still 0 / 1,594 translated, so every Hindi page falls back to English - a Devanagari font stack and spacing for `:lang(hi)` in `styles.css` @rollroyces I'm also happy to review the Hindi in #2862 if that helps. @uyg7x this changes our plan: the wiring will come from #2862, so there's no need to rebuild `docs/hindi`. Once #2862 merges, we could split the catalog between us.
Author
Owner

@uyg7x commented on GitHub (Oct 14, 2026):

Hi @ShivekRanjan @morluto — I've completed the remaining items for this issue!

I've opened a PR that includes:

  • Devanagari font stack + letter-spacing: normal for :lang(hi) in styles.css
  • The hi registration in languages.json and the base README_hi.md
  • The generated website/locales/hi/messages.po with 19 core UI strings translated

PR: https://github.com/morluto/rea/pull/3547

The remaining strings fall back to English safely. Happy to continue translating the rest in follow-up PRs!

<!-- gh-comment-id:6172289299 --> @uyg7x commented on GitHub (Oct 14, 2026): Hi @ShivekRanjan @morluto — I've completed the remaining items for this issue! I've opened a PR that includes: - Devanagari font stack + `letter-spacing: normal` for `:lang(hi)` in `styles.css` - The `hi` registration in `languages.json` and the base `README_hi.md` - The generated `website/locales/hi/messages.po` with 19 core UI strings translated PR: https://github.com/morluto/rea/pull/3547 The remaining strings fall back to English safely. Happy to continue translating the rest in follow-up PRs!
Author
Owner

@ShivekRanjan commented on GitHub (Oct 14, 2026):

@uyg7x Thanks for picking this up. A few things I noticed reading the diff:

  • website/public/assets/styles.css isn't in the diff, so the Devanagari font stack and letter-spacing for :lang(hi) described above aren't included yet.
  • docs/readme/README_hi.md is identical to the English README.md. #2862 already has a full Hindi README and the same hi entry in languages.json, so these two parts will conflict with it. It might be simpler to drop them here and build on #2862 once it merges.
  • The ten files under tests/fixtures/nativeaot/obj/ look like local build outputs and can be removed.
  • As Greptile notes, the website pages also need re-syncing for website.py check to pass.

On the CSS: I'd mentioned taking it in #2937, so I'm happy to open it as a small separate PR, unless you'd rather add it here. Let me know so we don't both do it.

<!-- gh-comment-id:6178471333 --> @ShivekRanjan commented on GitHub (Oct 14, 2026): @uyg7x Thanks for picking this up. A few things I noticed reading the diff: - `website/public/assets/styles.css` isn't in the diff, so the Devanagari font stack and `letter-spacing` for `:lang(hi)` described above aren't included yet. - `docs/readme/README_hi.md` is identical to the English `README.md`. #2862 already has a full Hindi README and the same `hi` entry in `languages.json`, so these two parts will conflict with it. It might be simpler to drop them here and build on #2862 once it merges. - The ten files under `tests/fixtures/nativeaot/obj/` look like local build outputs and can be removed. - As Greptile notes, the website pages also need re-syncing for `website.py check` to pass. On the CSS: I'd mentioned taking it in #2937, so I'm happy to open it as a small separate PR, unless you'd rather add it here. Let me know so we don't both do it.
Sign in to join this conversation.
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#1034
No description provided.