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

Remove all uses of just, simple, simply, and straighforward in the docs #936

Merged
merged 1 commit into from
Nov 16, 2024

Conversation

ayushn21
Copy link
Member

@ayushn21 ayushn21 commented Nov 8, 2024

As it says on the tin .... I think in most cases these words don't add a lot of value and come across as patronising. I've rewritten lines in the docs where I've felt it appropriate ... but for the most part it was "find and delete".

My motivation for this came from:
https://justsimply.dev
http://jackkelly.name/blog/archives/2019/09/20/avoid_just_and_simply_in_documentation/index.html

@ayushn21 ayushn21 requested a review from jaredcwhite November 8, 2024 13:49
@jaredcwhite
Copy link
Member

Ooo, I like this @ayushn21! Good call.

I have a another WIP PR, #912 with a bunch of docs updates for v2.0, so I'm thinking I'll comb through that and make similar improvements, and then we'll have to figure out how to merge that and this together without bewildering conflicts…

@ayushn21
Copy link
Member Author

ayushn21 commented Nov 11, 2024

we'll have to figure out how to merge that and this together without bewildering conflicts

Welp. yeah that'll be tricky. Let me know if you need me to look at anything!

Copy link
Member

@jaredcwhite jaredcwhite left a comment

Choose a reason for hiding this comment

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

LGTM!

@jaredcwhite jaredcwhite merged commit 7f61d10 into bridgetownrb:main Nov 16, 2024
3 checks passed
@ayushn21 ayushn21 deleted the docs-improvements branch November 16, 2024 23:59
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

Successfully merging this pull request may close these issues.

2 participants