Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Update index.md #6933
To be honest, I didn't find that most these changes were helpful or made the page any more readable. I prefer how it was before.
I do think the line:
Be aware of these messages if you wish to avoid certain death.
Could be better though - so changing it to 'Common pitfalls to avoid.' is an improvement
Welcome @Awjin, good to have you here.
While I don't mind most of the changes, I think I'm with @coliff when it comes to concerns about readability. Swapping out the intro 'graph' for a bulleted list (where people then have to read individual items) doesn't feel right.
It becomes, "read item, stop, read item, stop, etc." and disrupts the flow of the text.
Thanks for the reviews everyone.
@coliff : How do you feel about the other "tooltip" sections? A lot of them had redundant descriptions that I deleted.
@chrisfinazzo : Points well taken, I added an inline comment
Also, I'm realizing it would've been better to split these edits into separate commits with my rationale as commit messages. I'll do that next time.
From a review standpoint, it's not a big deal, although it should make integration easier if it ever becomes necessary to do any