-
-
Notifications
You must be signed in to change notification settings - Fork 11
[Documentation] Add information on what not to document #17
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
base: main
Are you sure you want to change the base?
[Documentation] Add information on what not to document #17
Conversation
Ivorforce
left a comment
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.
This could use a comment about what to do in this situation.
I'm thinking about something like this:
- User experiments finds some strange behavior
- User tries to document it
- Area maintainer is notified, regards the behavior as bug
- Maintainer fixes the bug
- Documentation PR is changed to document the new, intended behavior.
|
Realized I forgot a note that I was going to add, something like "If you are uncertain, please ask the relevant team" Note that this is more for things like "after creating a node X is in Y state" or "drawing two things in a row has X effect", as opposed to not documenting bugs, though that is important too |
6d07299 to
8752241
Compare
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.
I think the new section is great, but it's a little too long for my taste.
I tried to juggle the information around a bit, and I think i've arrived at something that brings the same message across, but uses less words.
Ultimately it's a matter of taste though, so feel free to adapt my suggestions in a way that feels right to you!
8752241 to
aebd6ce
Compare
|
There got around to cleaning this up, did some rewording to make some of the details clearer and some for sentence flow but the suggestions really helped make this concise |
Ivorforce
left a comment
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.
LGTM
Still a bit rough and looking for some feedback, but something I thought important to document
Could be its own entire page as well if we want to expand a bit further even, the paragraphs are a bit lengthy so might be best, and it might not be in the right place I'm not entirely sure where it would be best placed