scribe-org / scribe-org/Scribe-iOS

Implement Quick Tutorial Flow with Noun Annotation Logic Rules

Open
#649 1 comment 1 reaction 1 assignee View on GitHub

@prince-0408 is already working on this.

Since May 3, 2026.

-next release-
Dominant language
Swift
Stars
169
Forks
109
PR merge metrics
No merged PRs in 30d

Description

Terms
Description

Description

The "Quick tutorial" button in the Installation tab currently has a blank action — clicking it does nothing. This issue tracks implementing the full interactive tutorial flow as designed in Figma, along with the logic rules for which chapters to show based on installed keyboards.

What Needs to Be Done

  • Wire the "Quick tutorial" button in InstallationVC to open the tutorial flow
  • Entry screen with tip card, description, chapter list, and "Start full tutorial" button
  • Individual chapter screens with interactive "Try it here" text fields so users actually practice using the keyboard — not just read about commands
  • Real-time correct/incorrect feedback on interactive steps
  • Hide Noun annotation chapter when only English keyboard is installed
  • Show "Non-Scribe keyboard" warning when a non-Scribe keyboard is active

Tutorial Chapters

Chapter Visibility Interactive Steps
Noun annotation Hidden for English-only users Write "Vater" then "Mutter" — observe gender tags M/F on keyboard top bar
Word translation Always shown Use the Scribe key to translate a word
Verb conjugation Always shown Use the Scribe key to conjugate a verb
Noun plurals Always shown Use the Scribe key to get a noun plural

Noun Annotation Logic Rules

Since English nouns have no grammatical gender, showing the Noun annotation chapter to English-only users is not sensible.

Installed Keyboards Noun Annotation Shown?
None installed ✅ Yes (user may install later)
Only English ❌ No
English + any gender-language ✅ Yes
Any gender-language only ✅ Yes

Languages that support noun-gender annotations: German, Spanish, French, Portuguese, Russian, Italian, Swedish, Norwegian, Danish, Hebrew, Indonesian

Notes

  • Keyboard detection should read installed keyboards from UserDefaults
  • Noun annotation has 2 interactive steps (Vater → Mutter) — other chapters are instruction-only
  • Wrong keyboard detection should check on screen appear and show guidance to switch to a Scribe keyboard

Related

  • Figma design: [Here]

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.