tutorial working across languages by ashb155 · Pull Request #618 · scribe-org/Scribe-Android

ashb155 · 2026-06-13T19:36:50Z

Contributor checklist

This pull request is on a separate branch and not the main branch
I have tested my code with the ./gradlew lintKotlin detekt test command as directed in the testing section of the contributing guide

Description

This PR updates the quick tutorial to dynamically adapt its prompts, hints, and expected inputs based on the user's active Scribe keyboard language, resolving the issue of users being forced to use the German layout.

Key Changes:

Dynamic Content: Refactored TutorialContent.kt to supply localized words ("Mother"/"Father", gender tags) and hints for all 8 supported languages.
Reactive UI: Added a BroadcastReceiver in TutorialNavigator.kt to instantly update the tutorial text if the user switches keyboards mid-tutorial.

Related issue

Closes #616

github-actions · 2026-06-13T19:37:17Z

Thank you for the pull request! 💙🩵

The Scribe-Android team will do our best to address your contribution as soon as we can. The following are some important points:

Those interested in developing their skills and expanding their role in the community should read the mentorship and growth section of the contribution guide
If you're not already a member of our public Matrix community, please consider joining!
- We'd suggest that you use the Element client as well as Element X for a mobile app
- Join the General and Android rooms once you're in
Also consider attending our bi-weekly Saturday developer syncs!
- Details are shared in the General room on Matrix each Wednesday before the sync
- It would be great to meet you 😊

Note

Scribe uses Conventional Comments in reviews to make sure that communication is as clear as possible.

github-actions · 2026-06-13T19:37:18Z

Maintainer Checklist

The following is a checklist for maintainers to make sure this process goes as well as possible. Feel free to address the points below yourself in further commits if you realize that actions are needed :)

Tests for changes have been written and the unit test, linting and formatting workflows within the PR checks do not indicate new errors in the files changed
- Tests may need to be reran as they're at times not deterministic
The CHANGELOG has been updated with a description of the changes for the upcoming release and the corresponding issue (if necessary)

andrewtavis · 2026-06-23T17:50:21Z

Hey @ashb155! A couple of comments on this from playing around with it :)

Let's do "mother" before "father"
For noun annotation, we should direct the user to also press space after typing the word in the directions
It's be great if we also accept capitalized versions of the words, so "Padre" as well as "padre" for Spanish
Ideally the "Next" button would also move up above the keyboard when it's active so that the user can directly press it
- As of now the user needs to type the word, press enter and then they can see the "Next" button
We don't need the "If your second language is not..." message anymore as the tutorial is multilingual ✨
Can we change the 🌐 emoji to the similar icon? I think that'd look a bit more professional.
Let's get rid of the right arrow before "Scribe key" in the directions
- Should we do something like "Press the Scribe key that looks like a pencil at the top left corner of your keyboard. Then select {keyboard option}"
It looks like we also need to localize the command key names in the messages to the user
- We have "Übersetzen", "Konjugieren" and "Plural" in messages to the user, even if they're Spanish

andrewtavis · 2026-06-23T17:57:42Z

Would you also want to look into opening a PR in Scribe-i18n with the strings that are needed for the tutorial?

CC @prince-0408 and @angrezichatterbox for discussions about Scribe-i18n for Scribe-Android - let's continue to make sure that we have all the strings in that are needed for the apps in Scribe-i18n 👋

ashb155 · 2026-06-23T18:02:14Z

hi @andrewtavis, thanks for your review and detailed comments, will have a look and work on them

also with regards to the PR for Scribe-i18n, sounds good, how about I hardcode the required strings as of now (as done in the PR), and later on once finalized we could maybe have a PR for i18n

andrewtavis · 2026-06-23T18:05:04Z

Hard coding now and then migrating them to Scribe-i18n and then updating Scribe-i18n within the Android app is the exact thing we'd do, @ashb155 😊 Thanks so much! Looking forward to further commits!

andrewtavis · 2026-07-05T18:23:31Z

Note @ashb155: We've been updating the Scribe-i18n project with many strings that are needed for the project. We did a few of the strings for the tutorial, which are now on main. Would be great if these could be brought into this PR as well.

Also let us know what the other strings that are needed for the tutorial are. You could also do a PR to Scribe-i18n with them. You can see the related strings here:

https://github.com/scribe-org/Scribe-i18n/blob/12cffbc2188b1c3c9bc9ed482ebb4fcaea2d9ef9/i18n/locales/en-US.json#L115

Let us know if you need any support here!

andrewtavis · 2026-07-11T08:41:09Z

Note that the plan is that we'll finalize scribe-org/Scribe-i18n#116 and then bring in the updated Scribe-i18n into this PR :)

andrewtavis · 2026-07-12T22:22:56Z

Feel free to bring in the new version of Scribe-i18n as described in the shell scripts of the repo root/contributing guide, @ashb155 :) So great that this is making such good progress 😊

andrewtavis · 2026-07-12T22:23:44Z

note @angrezichatterbox: This should be ready for review as soon as the Scribe-i18n and related refactor come in :)

andrewtavis · 2026-07-24T23:52:34Z

Let us know when this is ready for a final review, @ashb155!

ashb155 · 2026-07-25T08:20:08Z

fixed the merge conflicts @andrewtavis , do let me know if it's good to go!

angrezichatterbox · 2026-07-26T17:09:49Z

Taking a look over this now : )

angrezichatterbox

Thanks for the wonderful work @ashb155 Have a few things that I wanted to be checked from your end. I will be happy to get those done if you are occupied with work. Thanks again for the awesome work.

angrezichatterbox · 2026-07-26T17:19:59Z

+        val (fatherWord, fatherTag, fatherGender) =
+            when (languageCode) {
+                "en" -> Triple("father", "M", "Masculine")
+                "es" -> Triple("padre", "M", "Masculino")
+                "fr" -> Triple("père", "M", "Masculin")
+                "it" -> Triple("padre", "M", "Maschile")
+                "pt" -> Triple("pai", "M", "Masculino")
+                "ru" -> Triple("отец", "M", "Мужской")
+                "sv" -> Triple("far", "C", "Common")
+                else -> Triple("Vater", "M", "Maskulin")
+            }
+
+        val (motherWord, motherTag, motherGender) =
+            when (languageCode) {
+                "en" -> Triple("mother", "F", "Feminine")
+                "es" -> Triple("madre", "F", "Femenino")
+                "fr" -> Triple("mère", "F", "Féminin")
+                "it" -> Triple("madre", "F", "Femminile")
+                "pt" -> Triple("mãe", "F", "Feminino")
+                "ru" -> Triple("мать", "F", "Женский")
+                "sv" -> Triple("mor", "C", "Common")
+                else -> Triple("Mutter", "F", "Feminin")
+            }
+


Could you correct the chracter we use to indicate the feminine neutral and masucline in case of certain languages like russian within the copy thats shown to user in noun suggestion.

angrezichatterbox · 2026-07-26T17:23:15Z

+    fun getNounAnnotationSteps(
+        languageCode: String,
+        context: Context,
+    ): List<TutorialStep> {
+        val (fatherWord, fatherTag, fatherGender) =


For some languages could u verify wheather the nouns have gender in the db. If not we could have them checked on why the aren't present.

I wasn't able to get mother in english for example

Mother in English shouldn't have a gender. If the user just has English installed, then we should maybe disable that tutorial option. If the user has say German and English, then we should have an option for no noun annotations for English. We should similarly have this for languages where verb conjugation isn't a thing 😊

angrezichatterbox · 2026-07-26T17:24:22Z

     */
-    val wordTranslationSteps =
-        listOf(
+    fun wordTranslationSteps(
+        languageCode: String,
+        context: Context,
+    ): List<TutorialStep> {
+        val translation =
+            when (languageCode) {
+                "en" -> "Translate"
+                "es" -> "Traducir"
+                "fr" -> "Traduire"
+                "it" -> "Tradurre"
+                "pt" -> "Traduzir"
+                "ru" -> "Перевести"
+                "sv" -> "Översätt"
+                else -> "Übersetzen"
+            }
+        return listOf(
            TutorialStep(
                instruction =
-                    "Let's translate! Tap the \u27A1 Scribe key on the top-left " +
-                        "corner of your keyboard, and select \u00DCbersetzen.\n\n" +
-                        "Then write the word you want to translate, press \u25B6, " +
-                        "and the translation will be returned to you.",
-                hint = "If your second language is not German, change the language in your keyboard.",
+                    context
+                        .getString(R.string.i18n_app_keyboard_tutorial_word_translation_instruction)
+                        .replace("{translate}", translation),


Could you do the same as above for this and check as well

andrewtavis · 2026-07-26T18:42:14Z

I'll add some strings into Scribe-i18n for noun annotation and verb conjugation not being an option for the language :)

andrewtavis · 2026-07-26T19:41:52Z

@ashb155, you can bring in the new version of Scribe-i18n and that will give you the *.invalid_language keys and values that have been added. It would be great if we use those for cases where the language doesn't use the feature, which for now is just English with noun annotation :)

ashb155 added 2 commits June 14, 2026 00:44

- reactive tutorial changes

7562207

- formatting fixes

0b07a93

ashb155 changed the title ~~Tutorial working across languages~~ tutorial working across languages Jun 13, 2026

andrewtavis self-requested a review June 23, 2026 17:50

andrewtavis added the -next release- Included in the next release label Jul 5, 2026

- tutorial fixes

6ef752f

andrewtavis mentioned this pull request Jul 11, 2026

Add strings for quick tutorial to Scribe-i18n scribe-org/Scribe-i18n#116

Closed

2 tasks

andrewtavis requested a review from angrezichatterbox July 12, 2026 22:23

andrewtavis mentioned this pull request Jul 13, 2026

Add description attributes to all app texts for sight impaired a11y support #649

Merged

i18n update

ddf9640

ashb155 added 3 commits July 25, 2026 11:16

Merge remote-tracking branch 'origin/main' into reactivetutorial

0ba812f

Merge upstream/main and resolve conflicts

9b56ef1

formatting fixes

3bf71e7

angrezichatterbox reviewed Jul 26, 2026

View reviewed changes

Uh oh!

Conversation

ashb155 commented Jun 13, 2026

Contributor checklist

Description

Related issue

Uh oh!

github-actions Bot commented Jun 13, 2026

Thank you for the pull request! 💙🩵

Uh oh!

github-actions Bot commented Jun 13, 2026

Maintainer Checklist

Uh oh!

andrewtavis commented Jun 23, 2026

Uh oh!

andrewtavis commented Jun 23, 2026

Uh oh!

ashb155 commented Jun 23, 2026

Uh oh!

andrewtavis commented Jun 23, 2026

Uh oh!

andrewtavis commented Jul 5, 2026

Uh oh!

andrewtavis commented Jul 11, 2026

Uh oh!

andrewtavis commented Jul 12, 2026

Uh oh!

andrewtavis commented Jul 12, 2026

Uh oh!

andrewtavis commented Jul 24, 2026

Uh oh!

ashb155 commented Jul 25, 2026

Uh oh!

angrezichatterbox commented Jul 26, 2026

Uh oh!

angrezichatterbox left a comment

Choose a reason for hiding this comment

Uh oh!

angrezichatterbox Jul 26, 2026

Choose a reason for hiding this comment

Uh oh!

angrezichatterbox Jul 26, 2026

Choose a reason for hiding this comment

Uh oh!

angrezichatterbox Jul 26, 2026

Choose a reason for hiding this comment

Uh oh!

andrewtavis Jul 26, 2026

Choose a reason for hiding this comment

Uh oh!

angrezichatterbox Jul 26, 2026

Choose a reason for hiding this comment

Uh oh!

andrewtavis commented Jul 26, 2026

Uh oh!

andrewtavis commented Jul 26, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants