Skip to content

feat: add interactive tutorial onboarding flow#605

Open
Mailos07 wants to merge 4 commits intoscribe-org:mainfrom
Mailos07:features/tutorials
Open

feat: add interactive tutorial onboarding flow#605
Mailos07 wants to merge 4 commits intoscribe-org:mainfrom
Mailos07:features/tutorials

Conversation

@Mailos07
Copy link
Copy Markdown

Contributor checklist

Description

Adds an interactive tutorial onboarding flow accessible from the About tab, based on the Figma designs for the tutorial screens. The tutorial guides new users through Scribe's core features with hands-on practice rather than passive video.

Discussed and approved by @andrewtavis on Matrix prior to implementation.

Changes

  • New TutorialHomeScreen — landing page with chapter list and "Start full tutorial" button
  • New TutorialStepScreen — reusable interactive lesson component with input validation and Scribe keyboard detection
  • New TutorialNavigator — navigation controller managing flow between chapters and steps
  • New WrongKeyboardScreen — guides users to switch to a Scribe keyboard when a non-Scribe keyboard is active, with a focused input field that triggers the system keyboard for easy switching
  • Modified AboutScreen — adds a "Start full tutorial" button to launch the tutorial flow

Tutorial chapters

  • Noun annotation — interactive practice with input validation (Vater, Mutter)
  • Word translation — instructional walkthrough of the Übersetzen command
  • Verb conjugation — instructional walkthrough of the Konjugieren command
  • Noun plurals — instructional walkthrough of the Plural command

Notes

  • Tutorial text is currently hardcoded in English. Migration to Scribe-i18n can be done in a follow-up PR.
  • The Verb Conjugation chapter is instructional only for now, since the Scribe-Server verb conjugation data issue is being resolved separately. Once that's fixed, this chapter can be expanded into an interactive exercise similar to Noun Annotation.

Related

References discussion on Matrix where this in-app guided onboarding tutorial was discussed and approved by @andrewtavis prior to implementation.

Related issue

@github-actions
Copy link
Copy Markdown

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
Copy link
Copy Markdown

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)

Copy link
Copy Markdown

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

First PR Commit Check

  • The commit messages for the remote branch should be checked to make sure the contributor's email is set up correctly so that they receive credit for their contribution
    • The contributor's name and icon in remote commits should be the same as what appears in the PR
    • If there's a mismatch, the contributor needs to make sure that the email they use for GitHub matches what they have for git config user.email in their local Scribe-Android repo (can be set with git config --global user.email "GITHUB_EMAIL")

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