-
Notifications
You must be signed in to change notification settings - Fork 6.3k
Docs copyedits: README.md + CONTRIBUTING.md #2242
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
Conversation
If it's not a problem, I'd like to move contributing to the root level a la other open-source projects.
Sounds good!
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.
Could you justify some of these changes? It's not clear to me what was improved.
@nhooyr Sure -- was there anything in particular that stood out for you? My goal is to make docs as clear as possible. The copy edits (spelling, grammar, etc.) are self-explanatory. I had to read some things multiple times to understand (I try to look at things from the perspective of someone who is completely new), and in some parts, it seemed the context/explanations were reversed.
@nhooyr Sure -- was there anything in particular that stood out for you? My goal is to make docs as clear as possible. The copy edits (spelling, grammar, etc.) are self-explanatory. I had to read some things multiple times to understand (I try to look at things from the perspective of someone who is completely new), and in some parts, it seemed the context/explanations were reversed.
Fair enough! As writer of these docs, I'm very biased in my opinion and understanding of them so I'll defer to you. I'll add some comments.
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.
Overall 👍🏼
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 @khorne3
@nhooyr What do I need to do re: failing checks?
@khorne3 you can ignore those, I'll merge 4 you after my last comment is addressed
37b49ad to
e166ae8
Compare
Thanks again @khorne3
Uh oh!
There was an error while loading. Please reload this page.
The first in a series of edits to the code-server docs.
Changes include copy edits and basic structural reorg to README.md, CONTRIBUTING.md for clarity. All feedback regarding changes welcome.
(削除) If it's not a problem, I'd like to move contributing to the root level a la other open-source projects. (削除ここまで)