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

Official spelling/casing of "shinylive" #134

Open
gadenbuie opened this issue May 22, 2024 · 2 comments
Open

Official spelling/casing of "shinylive" #134

gadenbuie opened this issue May 22, 2024 · 2 comments

Comments

@gadenbuie
Copy link
Contributor

Currently, we use "Shinylive" in the readme, changelog and function documentation, i.e. title-cased single-word "shinylive".

When read by VoiceOver (and likely other assistive technology), the name is read unnaturally. If the name is pascal-cased as "ShinyLive", however, the name is read as we expect.

shinylive-outloud.mp4

I'd like to propose we use ShinyLive as the official title of the project.

@wch
Copy link
Collaborator

wch commented May 22, 2024

I don't really find the VoiceOver pronunciation issue particularly compelling, since it pronounces a lot of words in a weird way. I think that if we change the names of things primarily to make VoiceOver pronounce them better, that's kind of putting the cart before the horse.

One could use that line of reasoning to argue for renaming all sorts of things. I got a kick out of this one 🙂:

ggplot2-half.mp4

(And I should note that it does a much better job pronouncing "shinylive" than it does "ggplot2".)

As I recall it, when we initially decided on the name, we were sort of on the fence about whether to go with "Shinylive" vs "ShinyLive", and there wasn't a particularly strong reason that we went with the first one. I think it came down to just feelings about it, which are definitely subjective.

With all that said, I wouldn't necessarily be opposed to a change to "ShinyLive", but I think we'd want other reasons besides the screen reader pronunciation, like maybe it's better branding, or it's less confusing, or something like that.

@gadenbuie
Copy link
Contributor Author

ggplot2 is a package name; the conventions for package naming are quite different. For example, I think it makes sense that we have Python and R packages named shinylive but call the website and the overall technology ShinyLive.

There's a lot of advice online urging use of Pascal case for hashtags:

  1. https://tosbourn.com/accessible-hashtags/
  2. https://www.harvard.edu/in-focus/the-accessible-world/social-media-accessibility-best-practices/
  3. https://guides.cuny.edu/accessibility/hashtags

In addition to being better announced via screen readers, camel- or pascal-cased phrases without spaces are easier to read than unspaced word phrases. At the moment the word only exists in written form -- we don't have a logo and only use it in text when referring to shinylive.io or the technology -- so I think improved readability and accessibility, and lowered confusion, all directly contribute to better branding.

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

No branches or pull requests

2 participants