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

Add a Further Reading section to the README #306

Merged
merged 4 commits into from Nov 3, 2020
Merged

Conversation

jenweber
Copy link
Contributor

@jenweber jenweber commented Oct 9, 2020

Partially addresses #286

The goal is to help demonstrate why inclusive language is important, and help users to notice the ways in which they need thoughtful human editing, beyond alex, in order to have inclusive content.

I would like to find an article to replace the SheCanCode one, if anyone has ideas. It leans on an example from US politics, which I would like to avoid, when there are so many other things out there.

Feedback, edits, and additions welcome from anyone who is interested in this.

@wooorm
Copy link
Member

wooorm commented Oct 9, 2020

nice! I’m assuming the CI complains about line length and list bullets though.

harver should perhaps be capitalized?

I’m not sure about an alternative to SheCanCode 🤔

I also recently came across this one, https://incl.ca/disability-language-is-a-nuanced-thing/, which might be something you want to add or I can PR later.

Partially addresses get-alex#286

Capitalization
@jenweber
Copy link
Contributor Author

Hi @wooorm, thanks for the article suggestion. I included it in the list and replaced the SheCanCode article with a link to Textio. I capitalized Harver. I could use your help figuring out what to do with the quotes linting failures. If I swap the regular double quotes " for smart quotes, I get:

Expected `‘` to be used at this level of nesting, not `“`

If I use , I get:

576:61-576:62  warning  Expected `“` to be used at this level of nesting, not `‘`  quote  retext-quote

Any ideas?

Copy link
Member

@wooorm wooorm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All looks good: the quotes were a bit messed up: closing ones (“99”s) were used to start, and opening ones (“66”s) were used to end.

One more Q: should this be higher? This is good but just thinking about the position, as it’s pretty important info

readme.md Outdated Show resolved Hide resolved
readme.md Outdated Show resolved Hide resolved
@jenweber
Copy link
Contributor Author

Sure, I can move this up higher. Thanks for the help with the quote marks.

readme.md Outdated Show resolved Hide resolved
Co-authored-by: Titus <tituswormer@gmail.com>
@jenweber
Copy link
Contributor Author

jenweber commented Nov 3, 2020

Hi, I think maybe this is ready to merge now. Tests are green and I moved it above the FAQ. If you want, I can add similar content to the home page. Just let me know if you have any ideas for how you'd want it to look/read in that context.

@wooorm
Copy link
Member

wooorm commented Nov 3, 2020

Oh sorry I missed that, perfect!

@wooorm wooorm merged commit f9bcc22 into get-alex:main Nov 3, 2020
@wooorm wooorm added ⛵️ status/released This is released 📚 area/docs This affects documentation 🦋 type/enhancement This is great to have labels Nov 3, 2020
@wooorm
Copy link
Member

wooorm commented Nov 3, 2020

This is great, thanks so much @jenweber! 💐

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📚 area/docs This affects documentation ⛵️ status/released This is released 🦋 type/enhancement This is great to have
Development

Successfully merging this pull request may close these issues.

None yet

2 participants