Skip to content

docs: README and guide in Spanish, German, French and Russian, plus a translation guide - #157

Merged
lippdev merged 1 commit into
mainfrom
docs/more-languages
Oct 19, 2026
Merged

lippdev merged 1 commit into
mainfrom
docs/more-languages

Conversation

@lippdev

@lippdev lippdev commented Oct 19, 2026

Copy link
Copy Markdown
Owner

Why

The interface is in six languages since 1.6.2, but the README and the guide are only in English and Portuguese. Someone who finds the project on a German or Russian forum lands on a page they may not read, and there was no written path for people who want to help translate (the German translation came from a Reddit user on their own).

What

  • README.<code>.md and docs/GUIDE.<code>.md for es-ES, de-DE, fr-FR and ru-RU.
    • The READMEs are leaner on purpose: no version number (they link to releases/latest), no "What's new" and no roadmap, so a release doesn't require touching four more files. They point to CHANGELOG.en-US.md for news.
    • The guides translate every section except "Build from source", which links to the English one.
    • UI labels are taken from each language's Strings.<code>.json, so the docs say exactly what the app shows (e.g. „Zurück zum PC“, « Revenir au PC », «Вернуться к ПК»). Labels from Android TV settings, which the app doesn't have, use the usual local name with the English in parentheses where unsure.
    • Each translated page ends with a note that the English version wins if they differ.
  • Language bar on top of all 12 pages (replaces the old "🇧🇷 Leia em português" / "🇺🇸 Read in English" links).
  • docs/TRANSLATING.md (English): how to fix a line, how to add a language (the JSON, plus the six wiring steps: csproj ×2, LocalizationService, the test row, the installer, README/changelog, TESTING.md), style rules (placeholders, short text for the TV, tone, official names) and how to run the checks without Windows. Linked from "More" in the README in every language.
  • AGENTS.md: the catalogs rule listed three languages; it now lists all six and mentions the translated docs.

The guide mentions the "sentence left in English" check from #156, so this one reads best merged after it.

No changelog entry: nothing changes in the app.

Testing

  • All local links and #anchors across the 12 pages and TRANSLATING.md checked with a script (GitHub slug rules, Cyrillic and accented headings included): 0 broken.
  • Docs only; no code touched. The Windows build is left to CI.

🤖 Generated with Claude Code

… translation guide

The app speaks six languages but the docs only two. The new READMEs leave out
version numbers, "What's new" and the roadmap so they don't go stale every
release; the guides skip the build section and point to the English one. UI
labels come from each language's catalog. docs/TRANSLATING.md explains how to
fix a translation or add a language, and AGENTS.md now lists all six catalogs.

Co-Authored-By: Claude Opus 5.5 <[email protected]>

@pullfrog pullfrog Bot left a comment

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.

✅ No new issues found.

Reviewed changes This review covers the README and guide translations, language navigation, translation contribution guide, and repository documentation updates.

  • Localized documentation Adds Spanish, German, French, and Russian README and guide pages while keeping release-specific content out of the translated READMEs.
  • Language navigation Adds language links to the English and Portuguese README and guide pages and includes navigation on the new translations.
  • Translation instructions Documents catalog updates, wiring a new language, translation style, and cross-platform checks; updates AGENTS.md accordingly.

Pullfrog  | View workflow run | Using gpt-6-luna | 𝕏

@lippdev
lippdev merged commit 410a2d0 into main Oct 19, 2026
5 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.

1 participant