More inclusive language in the introduction docs
See original GitHub issueI’m submitting a…
[ ] Bug report
[x] Content update
[ ] Process update (build, deployment, ... )
Type of bug / changes
👋 I noticed that there are many instances of the word “simple” in your documentation. Unfortunately, words like this can make people feel frustrated and isolated while reading (myself included, hence the issue) - especially if they are facing issues.
If it’s alright with your team, I’d like to take a shot at updating the content to make it more inclusive. Particularly the Cypress Is Simple section of the Introduction, but perhaps some other places where it pops up as well. I enjoy using Cypress so I’d be happy to help 😊
Also if you’re interested or want more information on this topic, I’d highly recommend watching Jim Fisher’s Don’t Say Simply talk from Write the Docs Prague 2018 ✍️ 🤓
Thank you for the work you do and please let me know if you need more details!
Issue Analytics
- State:
- Created 4 years ago
- Reactions:10
- Comments:5 (4 by maintainers)
Top GitHub Comments
Just wanted to add a +1 to @carolstran’s issue. I used Cypress for the first time in an open source repo this week. While I love the documentation on the whole and think it’s been one of the more thorough and well-explained bits of software I’ve used, I did chuckle a bit at the ‘Cypress is simple’. I also ran into some bits of frustration that any person using something completely new for the first time might run into, and it didn’t feel ‘simple’ then. Integration testing can be a hard concept. You’ve got a great product and great documentation - I think this change will definitely help make it even better.
@carolstran When you open your PR, put this text in the beginning:
GitHub will link it to this issue and automatically close this when your PR is merged.