question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

More inclusive language in the introduction docs

See original GitHub issue

I’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:closed
  • Created 4 years ago
  • Reactions:10
  • Comments:5 (4 by maintainers)

github_iconTop GitHub Comments

2reactions
sbinlondoncommented, Oct 2, 2019

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.

0reactions
flotwigcommented, Oct 2, 2019

@carolstran When you open your PR, put this text in the beginning:

Closes #2120

GitHub will link it to this issue and automatically close this when your PR is merged.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Write inclusive documentation - Google Developers
Write inclusive documentation · On this page · Avoid ableist language · Avoid unnecessarily gendered language · Avoid unnecessarily violent language · Write...
Read more >
Google unveils 'woke' writing feature for 'inclusive language'
Google Docs introduced the “woke” feature this month that shows pop-up warnings to people typing in words or phrases considered to be non- ......
Read more >
Google Docs to push users to write with more 'inclusive ...
Google is getting set to roll out a new feature to its Google Docs platform that will push users to write with more...
Read more >
How to write inclusive documentation? - Document360
Five steps to produce inclusive documentation · 1. Use gender neutral terms · 2. Choose neutral and friendly tone · 3. Avoid using...
Read more >
New Google Docs feature to prompt users to use more gender ...
A new feature in Google Docs will prompt users to write in gender-neutral language to avoid offending colleagues or friends.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found