Skip to content

Conversation

@AThousandShips
Copy link
Member

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

@AThousandShips AThousandShips requested a review from a team October 22, 2025 11:08
@AThousandShips AThousandShips added the enhancement New feature or request label Oct 22, 2025
Copy link
Member

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

@AThousandShips
Copy link
Member Author

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

@AThousandShips AThousandShips force-pushed the to_document_or_not_to_document branch from 6d07299 to 8752241 Compare November 21, 2025 15:15
@AThousandShips AThousandShips marked this pull request as ready for review November 21, 2025 15:16
@AThousandShips AThousandShips changed the title [WIP][Documentation] Add information on what not to document [Documentation] Add information on what not to document Nov 21, 2025
Copy link
Member

@Ivorforce Ivorforce left a 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!

@AThousandShips AThousandShips force-pushed the to_document_or_not_to_document branch from 8752241 to aebd6ce Compare December 10, 2025 12:00
@AThousandShips
Copy link
Member Author

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

Copy link
Member

@Ivorforce Ivorforce left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants