Skip to content
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

[material-ui][docs] Add details on appropriate usage to component demo pages #39735

Open
1 task done
basilnoor opened this issue Nov 3, 2023 · 2 comments
Open
1 task done
Assignees
Labels
docs Improvements or additions to the documentation enhancement This is not a bug, nor a new feature package: material-ui Specific to @mui/material

Comments

@basilnoor
Copy link

Duplicates

  • I have searched the existing issues

Related page

https://mui.com/material-ui/react-avatar/

Kind of issue

Missing information

Issue description

Hello

I was looking through the documentation for some components and noticed that some of the components are hard to tell when they would be useful. I'm looking to make a few changes to add additional information for such components.

For example the "Chip" component has a short description of what it is then is followed by why it is useful. I think including that why it's useful can benefit other components like "Avatar" which are missing it. This can help newer developers get an understanding of when to use the component.

Context 🔦

No response

@basilnoor basilnoor added status: waiting for maintainer These issues haven't been looked at yet by a maintainer support: docs-feedback Feedback from documentation page labels Nov 3, 2023
@zannager zannager added the component: chip This is the name of the generic UI component, not the React module! label Nov 6, 2023
@mnajdova mnajdova assigned samuelsycamore and unassigned siriwatknp Nov 8, 2023
@mnajdova mnajdova removed the component: chip This is the name of the generic UI component, not the React module! label Nov 8, 2023
@zannager zannager added the docs Improvements or additions to the documentation label Nov 8, 2023
@mj12albert
Copy link
Member

This can help newer developers get an understanding of when to use the component.

For many Material UI components, this guidance is provided by the Material Design spec, e.g. for the Chip: https://m2.material.io/components/chips#types

Perhaps we could link to the relevant spec on the component pages where applicable 🤔 like here:
Screenshot 2023-11-20 at 9 19 31 PM

@samuelsycamore
Copy link
Contributor

Thanks for the feedback @basilnoor ! I agree that the components should offer instructions for proper usage (like when to use an Alert, vs a Snackbar, vs a Dialog). This is something we've been doing more of in the Joy UI documentation, and we should take it into consideration when working on #35158.

@samuelsycamore samuelsycamore added enhancement This is not a bug, nor a new feature and removed status: waiting for maintainer These issues haven't been looked at yet by a maintainer labels Dec 1, 2023
@samuelsycamore samuelsycamore changed the title [docs] Improve documentation such that it is more accessible by newer developers [material-ui][docs] Add details on appropriate usage to component demo pages Dec 1, 2023
@samuelsycamore samuelsycamore added package: material-ui Specific to @mui/material and removed support: docs-feedback Feedback from documentation page labels Dec 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation enhancement This is not a bug, nor a new feature package: material-ui Specific to @mui/material
Projects
None yet
Development

No branches or pull requests

6 participants