posit-dev / posit-dev/shinylive
Official spelling/casing of "shinylive"
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 251
- Forks
- 25
- Avg merge
- 19m
- Merged PRs (30d)
- 2
Description
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.
https://github.com/posit-dev/shinylive/assets/5420529/3dbeba22-20be-4d8d-bc4a-f5833a345722
I'd like to propose we use ShinyLive as the official title of the project.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Search the README, changelog, and function documentation for the current "Shinylive" spelling. Update the project title to "ShinyLive" consistently, then review the affected text to confirm the new casing is used everywhere and supports the intended VoiceOver pronunciation.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100