-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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
docs: Proofreading + general improvements #26442
Conversation
Signed-off-by: kvanzuijlen <[email protected]>
Signed-off-by: kvanzuijlen <[email protected]>
bd13211
to
8e51968
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I actually like most of your changes, even though I'm suggesting a lot of changes... 🙃
Please go to the Files changed tab on GitHub, and batch my suggestions. Do not apply my suggestions one by one!
Read the GitHub Docs, to learn how to batch apply suggestions.
Please also make sure to revert the ordered lists to this format:
1. First item
1. Second item
1. Third item
1. And so on
Also, please do not force push to this branch. We squash-merge later, so the PR title becomes the final commit message. |
Co-authored-by: HonkingGoose <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the in-depth review @HonkingGoose! Some really good points that were great improvements on lines I only checked for grammar, thanks!
Signed-off-by: kvanzuijlen <[email protected]>
Signed-off-by: kvanzuijlen <[email protected]>
@HonkingGoose I updated all lists to follow the styling guide as added by you in #26445. I also reverted the quotes I edited by mistake. |
Merge-conflict resolved due to an overlapping change in #26478 |
@HonkingGoose Can you resolve the conversations that are done/resolved? Might be easier to read for the maintainers that way. |
@kvanzuijlen I don't have write rights to this repository. So only the maintainers can resolve discussions. 🙂 |
@kvanzuijlen you can resolve discussions yourself when they are done |
Completely overlooked that, as well as the fact that there were some more comments... Thanks! |
Co-authored-by: HonkingGoose <[email protected]>
Goedemiddag @kvanzuijlen. I see you collapsed a considerable amount of "you are", "they will", and "do not" into "you're", "they'll", and "don't" respectively. Why was that? Renovate aims for a wide audience with a diverse level of proficiency in English. The explicit version may be more accessible. |
It makes it easier to read for me personally (sounds more natural), but I can see the other side of things as well, so I'm fine if it should be reverted as well. |
@kvanzuijlen yes, |
Do you also want me to change existing contractions? |
If you think there are others which could be more "simply" understandable then please go ahead, but otherwise it's not essential if you prefer not. Thanks! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Requires deconflicting
@HonkingGoose do you approve? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is nearly ready:
- Needs maintainer input for some questions
- Some small typo fixes and style changes
Be sure to expand the large file diffs, because some comments are "hiding" there. 😉
@rarkins can you decide on the questions put forward by @HonkingGoose? I'll deconflict the PR afterward and make the necessary changes! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Needs deconflicting. Please see my comments within the Conversations
Co-authored-by: HonkingGoose <[email protected]>
Co-authored-by: HonkingGoose <[email protected]>
Needs git conflicts resolved |
Hi, Sorry for my absence. I'll have a look at this later today. |
It took me a bit longer to look into it, sorry about that. I'm looking into it right now! |
Closing due to inactivity and conflicts. This PR is welcome to be reopened or replaced if time permits! |
Changes
I did some proofreading and some miscellaneous improvements (IMO)
Context
I noticed some typos in the docs, so I decided to have a better look at all the files.
Documentation (please check one with an [x])
How I've tested my work (please select one)
I have verified these changes via: