Where to find feedback

MUI receives feedback on its documentation through multiple channels:

• GitHub issues (typically labelled with docs and/or docs-feedback).
• Directly through the feedback form available on every page in the docs:
  • Comments from these forms, in turn, show up in the Slack channels TEAM-NAME-docs-feedback, depending on which product they relate to.
• To a lesser extent: Twitter, Stack Overflow, Discord, Zendesk.

GitHub issues and PRs

<aside> 💡 Get the Developer Advocate involved!

</aside>

• If an issue is labeled docs or docs-feedback. It’s probably a good idea to get the team’s Developer Advocate involved. You can tag them to join the conversation and/or assign them to work on a solution.
• PRs involving documentation should always be reviewed by a Developer Advocate before merging—this is crucial for us to stay consistent in terms of voice, tone, grammar, style, and structure across the product docs.

docs-feedback Slack channels

<aside> 💡 If you see something, say something!

</aside>

These channels on Slack use a system of emojis so that everybody can quickly pitch in to help ensure that all feedback gets addressed.

• 👍 on a message means “I agree, this is something that needs to be addressed.”
• 🤔 = “I don't understand, or I'm not sure what to make of this comment”
• 🔻 = “this is not useful feedback” (if it’s purely spam or noise, you can simply delete it)
• ❤️ = “the user just wants to show us some love with this comment”
• 🫡 = “I will take care of this”
• ✅ = “there’s a PR for this”

If you open a PR to address feedback, be sure to link that PR in the feedback comments on Slack so others can see that it’s been handled.

If you see a piece of feedback that you want to save for later, you can do so through the More actions menu on the right side of the message. This adds the message to this spreadsheet: