-
Notifications
You must be signed in to change notification settings - Fork 493
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: polish README.md #656
Conversation
These changes (hopefully) make the README a bit more comprehensible.
This sentence is still a bit too terse IMHO:
Which updates are meant here? |
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.
Thank you for taking the time to polish the README, we appreciate it ✨
Left one comment, besides that looks good to me!
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 so much for taking the time to put this together, @dpprdan!
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 so much for taking the time to put this together, @dpprdan! (updating to "comment" rather than "approve" as that's the feedback level I meant initially, as we're still actively discussing a few things😄)
Co-authored-by: Brigit Murtaugh <[email protected]>
@bamurtaugh How would like to proceed here? Can this PR be merged? |
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 your contribution and collaboration!
@samruddhikhandale are you okay with approving the workflow run here? Since that's more your area of expertise, I'll hold off. |
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.
Apologies for a late review, looks like this PR slipped through the gaps.
Thanks @bamurtaugh for looping me in. Overall the PR looks great, left one minor comment.
Co-authored-by: Samruddhi Khandale <[email protected]>
7f58dbe
These changes make the README a bit more comprehensible (IMHO) and fixes a few typos.
I propose to discuss the changes for this single README first and then roll the changes out to the others as well (either with this or another PR).
cf #653