Skip to content

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

Merged
merged 5 commits into from
Oct 29, 2020
Merged

Docs copyedits: README.md + CONTRIBUTING.md #2242

merged 5 commits into from
Oct 29, 2020

Conversation

khorne3
Copy link
Contributor

@khorne3 khorne3 commented Oct 27, 2020

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.

@nhooyr
Copy link
Contributor

nhooyr commented Oct 27, 2020

If it's not a problem, I'd like to move contributing to the root level a la other open-source projects.

Sounds good!

Copy link
Contributor

@nhooyr nhooyr left a 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.

@khorne3
Copy link
Contributor Author

khorne3 commented Oct 28, 2020

@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
Copy link
Contributor

nhooyr commented Oct 28, 2020

@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.

Copy link
Contributor

@nhooyr nhooyr left a comment

Choose a reason for hiding this comment

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

Overall 👍🏼

Copy link
Contributor

@nhooyr nhooyr left a comment

Choose a reason for hiding this comment

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

Thanks @khorne3

@khorne3
Copy link
Contributor Author

khorne3 commented Oct 29, 2020

@nhooyr What do I need to do re: failing checks?

@nhooyr
Copy link
Contributor

nhooyr commented Oct 29, 2020

@khorne3 you can ignore those, I'll merge 4 you after my last comment is addressed

@nhooyr
Copy link
Contributor

nhooyr commented Oct 29, 2020

Thanks again @khorne3

@nhooyr nhooyr merged commit 860c99e into master Oct 29, 2020
@nhooyr nhooyr deleted the docs-edits branch October 29, 2020 21:21
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