CodeYourFuture / curriculum

The CYF Curriculum
https://curriculum.codeyourfuture.io
Other
34 stars 43 forks source link

Feature: click to pronounce #278

Open SallyMcGrath opened 1 year ago

SallyMcGrath commented 1 year ago

Which module(s) and week(s) does this change affect? Module(s): all Week(s): all

What is the work that needs to be done?

  1. Create an unobtrusive speech synthesis vanilla web component
  2. Add keyboard shortcut to speak selected

Why is this work important to do?

  1. The majority of CYFers are reading in a second language and want pronunciation guides to help them with specific terms they won't hear otherwise.
  2. Some CYFers prefer all spoken content over text

Additional context

Mathigon have a subtle click to read out loud button and this seems like a good thing to have on a paragraph level. https://mathigon.org/course/codes/introduction

Who might need to know about this change?

jobs-code commented 1 year ago

@SallyMcGrath Can I work on this issue? Could you please assign this to me?

SallyMcGrath commented 1 year ago

Hi @jobs-code 👋 😄

Sure, but before you get too deep in the weeds, how about you have a chat in the ticket about what you're proposing?

jobs-code commented 1 year ago

What are the requirements, expectations?

SallyMcGrath commented 1 year ago

So, looking at the ticket, what are your initial thoughts? What is the purpose of the component? In what technology should it be developed? How will you test this? What existing components are on the codebase that might inform you?