Add app hints to convey instruction/information

[wkyoshida]

Terms

• I have searched open and closed design issues
• I agree to follow Scribe-iOS' Code of Conduct

Description

WHAT

This issue is for app hints on each app page, i.e. overlaid text that provide quick instruction/information about a page (purpose of the page, what a user can do on the page, etc.) These would:

• Exist for each app page
• Automatically display the first time a user visits a page (will have to store this interaction history)
• Use a light bulb icon 💡 on each page that can be clicked to display the app hint for the page again

EXAMPLE USES

• Could be used to also prompt users to install keyboards if none are installed yet
• Within the keyboard settings, could display: “Here’s where you can change how each Scribe keyboard functions”

Contribution

• App hints planned as part of GSoC work by @SaurabhJamadagni
• Designs for the app hints will be made by @andrewtavis

[andrewtavis]

Designs are all done at this point 😊 I didn't put it in the prototype as I felt like it's not necessary to see exactly how it would work, but here's an image for documentation as well as the component :)

[fabulouiOS-monk]

Hi @andrewtavis, What's the status of this? Has anyone picked it up yet?
If not I can start with this 😄 !

[andrewtavis]

Hey @fabulouiOS-monk 👋 Sounds good :) This would be great to get some help with! As a first step, would you document some of the steps you'll take to work on this? Then once we agree on things you can get started on the coding 😊

[fabulouiOS-monk]

Hey @andrewtavis, Here's the Action plan:

1. Implement the UI for the tip card (let us call it a tip card). Since you already have the design prepared I will proceed with that, I just will need icon, and Color coding.

2. Capturing device-related data (I know we don't do it right now) but we will need it to check whether the user has newly downloaded the app or if he/she is new to the Scribe app.

3. Discuss which screens this tip card is really useful, and If we have old users where to place that light bulb icon, So that users can access the tip card anytime.

4. For new users the duration till the Tip card will be shown.

[andrewtavis]

Hey @fabulouiOS-monk 👋 Some feedback on this:

1. For the lightbulb icon use lightbulb.max from SF Symbols, and the designs here have the colors if you need that can be seen by selecting the app hint tooltips. All of the colors are already defined in the apps assets.

2. Let's avoid doing this. I think the way we planned it was to just have a default value, which thinking about it we'd need a default value for each page/hint. Once the tooltip is shown once, it goes to false, and then we'll also include a menu option in about to reset the app hints and then they'll all be true again.

3. Now I see what you mean by app data. For now let's just have it be set to true from the start, and hopefully that means that old users will see it and be annoyed by it once, but then people won't need to worry about it further. If it's being reset it each a new version is installed, then we can react to that with a new issue :)

4. For the duration, let's keep it easy on ourselves and have the tooltip disappear on click of ok, or if the user changes to a new screen. Maybe we can also get rid of it on any click of the screen, but we can discuss this with the larger community 😊

Let me know what you think on the above! Happy for further feedback on this! Really exciting to get this going 🚀

[fabulouiOS-monk]

Great let me have some work on it and let you know @andrewtavis!!

P.S: I might take some time on this, if it doesn't impact the release 😬

[andrewtavis]

Totally fine, @fabulouiOS-monk! This isn't necessary for the next release, so take your time and let us know how we can help!

[fabulouiOS-monk]

Hey @andrewtavis, Just for the updates!

1. I have been working on the view part, Initially I started with SwiftUI and integrated it with UIKit (but failed).
2. I have implemented the same in UIKit and am working on showing it on other views.

P.S.: I am not able to continuously work on it because of regular work.

[andrewtavis]

Thanks for the update and the hard work here, @fabulouiOS-monk! Appreciate the efforts, and no stress if it's taking some time 😊

[andrewtavis]

Closed by #459 🙌 Awesome that this was figured out so quickly and at such a perfect time, @fabulouiOS-monk! Thanks again :)