Skip to content
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.

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

[Feature Request]: Change Lessons/Revision to Learn/Study on the topic screen, and update "revision card" to "study guide" (where needed) #5651

Closed
seanlip opened this issue Jan 15, 2025 · 14 comments · Fixed by #5668
Assignees
Labels
enhancement End user-perceivable enhancements. good first issue This item is good for new contributors to make their pull request. Impact: Medium Moderate perceived user impact (non-blocking bugs and general improvements). Work: Low Solution is clear and broken into good-first-issue-sized chunks.

Comments

@seanlip
Copy link
Member

seanlip commented Jan 15, 2025

Is your feature request related to a problem? Please describe.

We've found that learners find it hard to understand the differences between the tabs in the topic screen in the Android app. In some cases they miss/skip the Revision tab altogether. See oppia/design-team#74 for more info.

Describe the solution you'd like

After discussion with the UX Writing team, we would like to rename these tabs to "Learn" and "Study", respectively.

Additionally, change "revision card" to "study guide" wherever it is used in the UI.

Also, when the corresponding PR is merged, please leave a comment on this doc to update it with the new terminology once the next Android release goes out.

Describe alternatives you've considered

No response

Additional context

No response

@seanlip seanlip added enhancement End user-perceivable enhancements. triage needed labels Jan 15, 2025
@seanlip seanlip changed the title [Feature Request]: Change Lessons/Revision to Learn/Study on the topic screen [Feature Request]: Change Lessons/Revision to Learn/Study on the topic screen, and update "revision card" to "study guide" (if needed) Jan 15, 2025
@seanlip seanlip changed the title [Feature Request]: Change Lessons/Revision to Learn/Study on the topic screen, and update "revision card" to "study guide" (if needed) [Feature Request]: Change Lessons/Revision to Learn/Study on the topic screen, and update "revision card" to "study guide" (where needed) Jan 15, 2025
@Harsh2118-hub
Copy link

@adhiamboperes I’d like to work on this issue.

@TanishMoral11
Copy link
Collaborator

Hi @Harsh2118-hub , we’d love to hear your proposed solution. If it sounds good, we’ll assign it to you and you can create a PR.

@Harsh2118-hub
Copy link

@TanishMoral11 can you please guide me how to approach on this issue

@TanishMoral11
Copy link
Collaborator

Hey @Harsh2118-hub ,
Apologies for the delay in responding. I’ve been a bit occupied with some other tasks. After reviewing this issue, I believe it might not be suitable as a “Good First Issue.” I recommend exploring other issues labeled as Good First Issue within the repository.

@adhiamboperes adhiamboperes added Impact: Medium Moderate perceived user impact (non-blocking bugs and general improvements). Work: Medium The means to find the solution is clear, but it isn't at good-first-issue level yet. good first issue This item is good for new contributors to make their pull request. labels Jan 22, 2025
@jainv4156
Copy link
Contributor

jainv4156 commented Jan 26, 2025

hey, I like to work on this issue

@jainv4156
Copy link
Contributor

The simplest solution could be to change the string resource to "Learn and Study." However, one issue arises. For example, consider the term "Lesson." We use "Lesson" extensively in our code for naming files, functions, and variables related to the "Lesson" tab. If we decide to rename it to "Learn," do we need to update all references in the code or only change what is necessary to make it work?

@TanishMoral11
Copy link
Collaborator

@jainv4156 , I believe that changing only the necessary references would be a good approach. Here’s what I suggest:

  • Update the string resources to reflect the new names, "Learn" and "Study".
  • Modify the UI elements that display these names to use the updated string resources.
  • Ensure that any user-facing text, such as labels and descriptions, is updated to use the new terminology.
  • Leave internal code references, such as file names, function names, and variable names, unchanged in order to avoid extensive refactoring.

@adhiamboperes Do you have any suggestions or thoughts on this approach?

@TanishMoral11
Copy link
Collaborator

Assigned this issue to you @jainv4156 .

@adhiamboperes adhiamboperes added Work: Low Solution is clear and broken into good-first-issue-sized chunks. and removed Work: Medium The means to find the solution is clear, but it isn't at good-first-issue level yet. labels Feb 3, 2025
@adhiamboperes
Copy link
Collaborator

@seanlip, this issue involves updating user-facing references of "revision card" to "Study Guide." However, the term "revision card" appears extensively in other areas, such as proto enums, assets, and related variable names. From a technical maintenance standpoint, should we limit the changes to UI strings while keeping everything else unchanged?

@seanlip
Copy link
Member Author

seanlip commented Feb 4, 2025

Hi @adhiamboperes, I think this is a decision for the technical leadership. Could you please check with @BenHenning and get his take on it?

Personally, I think getting rid of "revision card" completely might be better if it's easy and safe to do (we already have the term "subtopic page" on Web and will need to keep that in the storage layer, so it'd be good to drop "revision card" fully so that we don't end up with 3 names for the same thing). But I don't know where the "seams" on Android are, and which parts are hard to change, so I think it's better to align with @BenHenning on that.

@seanlip seanlip removed their assignment Feb 4, 2025
@BenHenning
Copy link
Member

I'm not keen on a massive codebase-wide rename here, especially since there's a nonzero chance we rename this again in the future (I'm not convinced the new name is stable enough). It seems like far more work than is beneficial right now, and is very likely to have unexpected consequences for some features like feedback reporting. It's definitely possible to do a rename like this, but it needs to be planned out. It seems a lot easier to document the equivalence of the features somewhere (i.e. probably a glossary on the wiki, and one or two key locations in code KDocs).

@adhiamboperes
Copy link
Collaborator

Thanks @BenHenning! @jainv4156 has so far made the string changes, and I believe we need to update the glossary wiki in the same PR.

@adhiamboperes
Copy link
Collaborator

@seanlip, this is now closed but we don't have the comment permissions for the linked doc. Assigning over to you!

@adhiamboperes adhiamboperes assigned seanlip and unassigned jainv4156 Feb 6, 2025
@seanlip
Copy link
Member Author

seanlip commented Feb 7, 2025

Thanks @adhiamboperes and @jainv4156 ! I've updated the doc so this issue can be considered fully complete.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement End user-perceivable enhancements. good first issue This item is good for new contributors to make their pull request. Impact: Medium Moderate perceived user impact (non-blocking bugs and general improvements). Work: Low Solution is clear and broken into good-first-issue-sized chunks.
6 participants