Small fixes in writing guide #1532
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Martinsos
reviewed
Oct 23, 2023
web/docs/writingguide.md
Outdated
| - **Kindly communicate rules/boundaries.** If someone behaves in a way that's abusive/inappropriate, respond only with kindness and maturity, but also make it clear that this behavior is not acceptable and what will happen (according to the code of conduct) if they continue behaving poorly. | ||
| - **All docs must go through the review cycle, preferably with more than a single reviewer.** Different people focus on different things. Some of us are great at coming up with examples, others easily come up with analogies and explain complex topics, some have a clear and concise writing style, etc. Therefore, try to get at least two or three people to review your document. | ||
|
|
||
| ## Possible improvements | ||
|
|
||
| - Some parts of our docs don't follow all the guidelines outlined in this document. There's no need to start fixing all the issues right away, we can slowly improve the docs as we edit them. | ||
| - We've talked about having a git repo with all the example code so it's easier to copy-paste, test, and maintain. | ||
| - We've talked about having a git repo with all the example code in the docs. This should make it easier to copy-paste, test, and maintain code snippets. |
There was a problem hiding this comment.
Aha, so all the example snippets in the code, they would all be somewhere as part of actual example project? All right yeah that could be useful, ok got it.
Martinsos
approved these changes
Oct 23, 2023
Martinsos
pushed a commit
that referenced
this pull request
Nov 17, 2023
Martinsos
pushed a commit
that referenced
this pull request
Dec 6, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.