Skip to content

feat: Implement Quick Tutorial flow with keyboard-based chapter filtering #650

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
prince-0408 wants to merge 4 commits into
base: main
Choose a base branch
from
Open

feat: Implement Quick Tutorial flow with keyboard-based chapter filtering #650

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
dd1fe13
feat: implement Quick Tutorial flow with keyboard-based chapter filte…
prince-0408 Apr 16, 2026
480ee90
chore: update i18n submodule with tutorial localization keys
prince-0408 Apr 16, 2026
264ae23
fix: remove explicit nil initialization for SwiftLint compliance
prince-0408 Apr 17, 2026
8a2aaee
Revert "chore: update i18n submodule with tutorial localization keys"
prince-0408 Apr 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions Scribe.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,13 @@
30489C262936DB0200B59393 /* ToolTipView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 30489C1D2936DAB700B59393 /* ToolTipView.swift */; };
38BD213422D5907F00C6795D /* AppDelegate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 38BD213322D5907F00C6795D /* AppDelegate.swift */; };
38BD213622D5907F00C6795D /* InstallationVC.swift in Sources */ = {isa = PBXBuildFile; fileRef = 38BD213522D5907F00C6795D /* InstallationVC.swift */; };
FA002BBB2F9B000000000001 /* TutorialView.swift in Sources */ = {isa = PBXBuildFile; fileRef = FA002BBA2F9B000000000001 /* TutorialView.swift */; };
FA002BBB2F9B000000000002 /* TutorialChapter.swift in Sources */ = {isa = PBXBuildFile; fileRef = FA002BBA2F9B000000000002 /* TutorialChapter.swift */; };
FA002BBB2F9B000000000003 /* TutorialChapterView.swift in Sources */ = {isa = PBXBuildFile; fileRef = FA002BBA2F9B000000000003 /* TutorialChapterView.swift */; };
FA002BBB2F9B000000000004 /* TutorialChapterContent.swift in Sources */ = {isa = PBXBuildFile; fileRef = FA002BBA2F9B000000000004 /* TutorialChapterContent.swift */; };
FA002BBB2F9B000000000005 /* TutorialTipCard.swift in Sources */ = {isa = PBXBuildFile; fileRef = FA002BBA2F9B000000000005 /* TutorialTipCard.swift */; };
FA002BBB2F9B000000000006 /* TutorialStep.swift in Sources */ = {isa = PBXBuildFile; fileRef = FA002BBA2F9B000000000006 /* TutorialStep.swift */; };
FA002BBB2F9B000000000007 /* TutorialKeyboardDetector.swift in Sources */ = {isa = PBXBuildFile; fileRef = FA002BBA2F9B000000000007 /* TutorialKeyboardDetector.swift */; };
38BD213922D5907F00C6795D /* AppScreen.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 38BD213722D5907F00C6795D /* AppScreen.storyboard */; };
38BD213E22D5908100C6795D /* Assets.xcassets in Resources */ = {isa = PBXBuildFile; fileRef = 38BD213D22D5908100C6795D /* Assets.xcassets */; };
38BD214122D5908100C6795D /* LaunchScreen.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 38BD213F22D5908100C6795D /* LaunchScreen.storyboard */; };
Expand Down Expand Up @@ -1041,6 +1048,13 @@
38BD213022D5907E00C6795D /* Scribe.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = Scribe.app; sourceTree = BUILT_PRODUCTS_DIR; };
38BD213322D5907F00C6795D /* AppDelegate.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AppDelegate.swift; sourceTree = "<group>"; };
38BD213522D5907F00C6795D /* InstallationVC.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = InstallationVC.swift; sourceTree = "<group>"; };
FA002BBA2F9B000000000001 /* TutorialView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TutorialView.swift; sourceTree = "<group>"; };
FA002BBA2F9B000000000002 /* TutorialChapter.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TutorialChapter.swift; sourceTree = "<group>"; };
FA002BBA2F9B000000000003 /* TutorialChapterView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TutorialChapterView.swift; sourceTree = "<group>"; };
FA002BBA2F9B000000000004 /* TutorialChapterContent.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TutorialChapterContent.swift; sourceTree = "<group>"; };
FA002BBA2F9B000000000005 /* TutorialTipCard.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TutorialTipCard.swift; sourceTree = "<group>"; };
FA002BBA2F9B000000000006 /* TutorialStep.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TutorialStep.swift; sourceTree = "<group>"; };
FA002BBA2F9B000000000007 /* TutorialKeyboardDetector.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = TutorialKeyboardDetector.swift; sourceTree = "<group>"; };
38BD213822D5907F00C6795D /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.storyboard; name = Base; path = Base.lproj/AppScreen.storyboard; sourceTree = "<group>"; };
38BD213D22D5908100C6795D /* Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; path = Assets.xcassets; sourceTree = "<group>"; };
38BD214022D5908100C6795D /* Base */ = {isa = PBXFileReference; lastKnownFileType = file.storyboard; name = Base; path = Base.lproj/LaunchScreen.storyboard; sourceTree = "<group>"; };
Expand Down Expand Up @@ -1551,6 +1565,20 @@
path = InstallationTab;
sourceTree = "<group>";
};
FA002BC02F9B000000000001 /* Tutorial */ = {
isa = PBXGroup;
children = (
FA002BBA2F9B000000000001 /* TutorialView.swift */,
FA002BBA2F9B000000000002 /* TutorialChapter.swift */,
FA002BBA2F9B000000000003 /* TutorialChapterView.swift */,
FA002BBA2F9B000000000004 /* TutorialChapterContent.swift */,
FA002BBA2F9B000000000005 /* TutorialTipCard.swift */,
FA002BBA2F9B000000000006 /* TutorialStep.swift */,
FA002BBA2F9B000000000007 /* TutorialKeyboardDetector.swift */,
);
path = Tutorial;
sourceTree = "<group>";
};
147797A92A2CD2B50044A53E /* AboutTab */ = {
isa = PBXGroup;
children = (
Expand Down Expand Up @@ -1661,6 +1689,7 @@
CE1378C128F5D7AC00E1CBC2 /* Colors */,
EDEE62232B2DE64A00A0B9C1 /* Extensions */,
1406B7882A2DFE4C001DF45B /* InstallationTab */,
FA002BC02F9B000000000001 /* Tutorial */,
D198B5CD2BFA954100E1BF4F /* i18n */,
EDB460222B03BF7000BEA967 /* Resources */,
147797B62A2CFB560044A53E /* SettingsTab */,
Expand Down Expand Up @@ -2897,6 +2926,13 @@
D180EC0328FDFABF0018E29B /* FR-AZERTYInterfaceVariables.swift in Sources */,
D1CDED7B2A859FBF00098546 /* ENInterfaceVariables.swift in Sources */,
38BD213622D5907F00C6795D /* InstallationVC.swift in Sources */,
FA002BBB2F9B000000000001 /* TutorialView.swift in Sources */,
FA002BBB2F9B000000000002 /* TutorialChapter.swift in Sources */,
FA002BBB2F9B000000000003 /* TutorialChapterView.swift in Sources */,
FA002BBB2F9B000000000004 /* TutorialChapterContent.swift in Sources */,
FA002BBB2F9B000000000005 /* TutorialTipCard.swift in Sources */,
FA002BBB2F9B000000000006 /* TutorialStep.swift in Sources */,
FA002BBB2F9B000000000007 /* TutorialKeyboardDetector.swift in Sources */,
D171942D27AECEB80038660B /* DEInterfaceVariables.swift in Sources */,
147797C02A2D0CDF0044A53E /* SettingsTableData.swift in Sources */,
E9F7273F2F45A6E60060B92D /* APIClient.swift in Sources */,
Expand Down
7 changes: 6 additions & 1 deletion Scribe/InstallationTab/InstallationVC.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -395,7 +395,12 @@ extension InstallationVC {
title: NSLocalizedString(
"i18n.app.installation.button_quick_tutorial", value: "Quick tutorial", comment: ""
),
action: {}
action: { [weak self] in
let tutorialView = TutorialView()
let hostingController = UIHostingController(rootView: tutorialView)
hostingController.modalPresentationStyle = .fullScreen
self?.present(hostingController, animated: true)
}
)

let hostingController = UIHostingController(rootView: ctaButton)
Expand Down
33 changes: 33 additions & 0 deletions Scribe/Tutorial/TutorialChapter.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
// SPDX-License-Identifier: GPL-3.0-or-later

import Foundation

enum TutorialChapter: String, CaseIterable, Identifiable, Hashable {
case nounAnnotation
case wordTranslation
case verbConjugation
case nounPlurals

var id: String { rawValue }

var title: String {
switch self {
case .nounAnnotation:
return NSLocalizedString("i18n.app.tutorial.noun_annotation", value: "Noun annotation", comment: "")
case .wordTranslation:
return NSLocalizedString("i18n.app.tutorial.word_translation", value: "Word translation", comment: "")
case .verbConjugation:
return NSLocalizedString("i18n.app.tutorial.verb_conjugation", value: "Verb conjugation", comment: "")
case .nounPlurals:
return NSLocalizedString("i18n.app.tutorial.noun_plurals", value: "Noun plurals", comment: "")
}
}

var isLast: Bool { self == .nounPlurals }

func next() -> TutorialChapter? {
let all = TutorialChapter.allCases
guard let idx = all.firstIndex(of: self), idx + 1 < all.count else { return nil }
return all[idx + 1]
}
}
95 changes: 95 additions & 0 deletions Scribe/Tutorial/TutorialChapterContent.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
// SPDX-License-Identifier: GPL-3.0-or-later

/**
* Content definitions for each tutorial chapter.
* Noun annotation has two steps (Vater → Mutter).
* Other chapters are single-step.
*/

import Foundation

private let languageNote = NSLocalizedString(
"i18n.app.tutorial.language_note",
value: "If your second language is not German, change the language in your keyboard.",
comment: ""
)

extension TutorialChapter {
var steps: [TutorialStep] {
switch self {
case .nounAnnotation:
return [
TutorialStep(
instructions: NSLocalizedString(
"i18n.app.tutorial.noun_annotation.step1",
value: "Write the word \"Vater\". Notice the word suggestions that appear on the keyboard's top bar.\n\nThen, press space. You will see the word's gender tag on the keyboard's top bar — in this case, \"M\" for Maskulin.",
comment: ""
),
languageNote: languageNote,
expectedInput: "Vater",
incorrectFeedback: NSLocalizedString(
"i18n.app.tutorial.noun_annotation.step1.incorrect",
value: "Not quite! Try writing Vater.",
comment: ""
)
),
TutorialStep(
instructions: NSLocalizedString(
"i18n.app.tutorial.noun_annotation.step2",
value: "Now write the word \"Mutter\" and then press space. The gender tag will be \"F\", for Feminin.",
comment: ""
),
languageNote: languageNote,
expectedInput: "Mutter",
incorrectFeedback: NSLocalizedString(
"i18n.app.tutorial.noun_annotation.step2.incorrect",
value: "Not quite! Try writing Mutter.",
comment: ""
)
)
]

case .wordTranslation:
return [
TutorialStep(
instructions: NSLocalizedString(
"i18n.app.tutorial.word_translation.instructions",
value: "Let's translate! Tap the ⌨ Scribe key on the top-left corner of your keyboard, and select Übersetzen.\n\nThen write the word you want to translate, press ▶, and the translation will be returned to you.",
comment: ""
),
languageNote: languageNote,
expectedInput: nil,
incorrectFeedback: ""
)
]

case .verbConjugation:
return [
TutorialStep(
instructions: NSLocalizedString(
"i18n.app.tutorial.verb_conjugation.instructions",
value: "On to the verbs. Tap the ⌨ Scribe key on the top-left corner of your keyboard, and select Konjugieren.\n\nWrite the verb you want to conjugate, press ▶, and you will see a table with all the verb tenses. Select the one you need and it will be inserted!",
comment: ""
),
languageNote: languageNote,
expectedInput: nil,
incorrectFeedback: ""
)
]

case .nounPlurals:
return [
TutorialStep(
instructions: NSLocalizedString(
"i18n.app.tutorial.noun_plurals.instructions",
value: "Finding the plural of a noun with Scribe is easy. Tap the ⌨ Scribe key on the top-left corner of your keyboard, and select Plural.\n\nThen write the noun you want the plural for, press ▶, and the plural will be returned to you.",
comment: ""
),
languageNote: languageNote,
expectedInput: nil,
incorrectFeedback: ""
)
]
}
}
}
Loading
Loading