Words Review Redesign

[tfnribeiro]

This has become quite a large change, but I will try to summarize the changes included.

This requires API changes: https://github.com/zeeguu/api/pull/156

Main features:

• Users can now edit the words directly when they are in the review page when 10 or more words have been translated. This is done by toggling an edit mode where users can add or review words.
• Paired with the previous feature, Zeeguu now prioritizes the top 10 most common words that the user translated to study in exercises. This is to limit the effect of a very long/difficult text where a user might reach the limit of 50 words.
• Zeeguu no longer allows words composed of 3 words or more to be used in exercises. These long words become very difficult in certain exercises, or too obvious in others (Match or Multiple Choice).
• The Star and Trash can have been removed throughout the app, to improve visual clarity.
• The Star feature has now been replaced by a user_preference field which overrides, either positively or negatively the fit_for_study status.
• The trash (deletion of the bookmark) is now part of the edit screen, consolidating all the edit options within a single screen.
• The user can also use the edit screen to add a word to their exercises. This is done via a checkmark, and they can toggle it to either add/remove.
• Added API endpoints that allow to override the backends fit_for_study when we want to limit the schedule to simply 10 words per article.
• Added API endpoints to control the user_preference
• Introduced a new InfoBox with an Icon to make it visually attractive and rounded the edges of all the info boxes to match the edges used in icons.
• General refactorings

Screencaps:

Review Word Screen

Desktop	Mobile

Review Word Screen (Editing)

Desktop	Mobile

Review Word Screen - InfoBox after user Edits

Review Word Screen - InfoBox if no words for exercises

New Edit Word Screen

Desktop	Mobile

[netlify[bot]]

✅ Deploy Preview for voluble-nougat-015dd1 ready!

Name	Link
🔨 Latest commit	ec3dd5a33044fe739048a85d6ae52f8c0ce7337b
🔍 Latest deploy log	https://app.netlify.com/sites/voluble-nougat-015dd1/deploys/66632c141de9db000847ed37
😎 Deploy Preview	https://deploy-preview-392--voluble-nougat-015dd1.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[tfnribeiro]

One thing I thought about, which is worth considering: If the user edits words during review, should we reschedule words when they come back?

Example (This is from the DEV environment, so no translations):

Initial Screen:

I remove 5 words:

I reload the page:

We can see that the words that weren't selected and not altered by the user are re-added for the user to study. Is this a behaviour we want? Or if the user has edited any of the words, we "freeze" that state and don't change it unless the user edits them?

[mircealungu]

One thing I thought about, which is worth considering: If the user edits words during review, should we reschedule words when they come back?

Example (This is from the DEV environment, so no translations):

Initial Screen:

I remove 5 words:

I reload the page:

We can see that the words that weren't selected and not altered by the user are re-added for the user to study. Is this a behaviour we want? Or if the user has edited any of the words, we "freeze" that state and don't change it unless the user edits them?

This is much more complicated than I've ever imagined :)

solutions

1. we expect them to not reload the page; if they reload it's their problem
2. we track their preference at the end of editing phase with some state representing "user-approved pre-pipeline bookmarks for article"?!
3. we track their indiference wrt. some words, i.e. add another state to each bookmark that says: "ignored in the past"...

I am tempted to let 1 happen. Let's see how people use this feature first before investing more in it.

[tfnribeiro]

@mircealungu But it's not that hard to implement the behavior of nothing changing. Here's how I did it:

This ensures if there is any bookmarks with user preference, then it's safe to assume the user has altered the original list - and that should cover most cases. This seeks to avoid the fact that I reduced the list to... say 2 words, and then I come back and have 10 again?