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] Improve documentation for "complementary" components #39952

Open
samuelsycamore opened this issue Nov 21, 2023 · 6 comments
Labels
docs Improvements or additions to the documentation package: material-ui Specific to @mui/material ready to take Help wanted. Guidance available. There is a high chance the change will be accepted support: docs-feedback Feedback from documentation page

Comments

@samuelsycamore
Copy link
Member

Feedback received:

Please include some example code in the demo. There are four different components listed at the bottom of this page, the API docs for three of them have no details about what they do or how to use them, they link back to this page with a "see our demo" message but then are ONLY mentioned at the very bottom in the link to the page I was just on. Documentation should be better than this. Show me how to use your system, I can't read the minds of strangers, let alone strangers who are obviously several orders of magnitude more experienced than I am if they built this library.

from https://mui.com/material-ui/react-accordion/#

I can empathize with this frustration. Material UI has lots of these complementary components (or maybe supplementary is a better term?) that don't have their own demo pages, because you would only ever use them in the context of their parent component. But they're not consistently documented in the parent demo docs either, leading to this awful UX loop:

  1. Look for info on Accordion Actions component usage on the Accordion page
  2. Find the link to the Accordion Actions API page and click through
  3. The API page, in turn, redirects you back to the Accordion demo page, which has no info about Accordion Actions other than the link to the API page

Not fun!

I think we've largely resolved this issue in the Joy and Base docs by consistently documenting these complementary components in their respective parent component demo pages. We need to comb through the Material UI docs to find these undocumented components and show users what to do with them.

@samuelsycamore samuelsycamore added docs Improvements or additions to the documentation package: material-ui Specific to @mui/material support: docs-feedback Feedback from documentation page labels Nov 21, 2023
@Triluk98
Copy link

Triluk98 commented Dec 4, 2023

I'd be interested in resolving this issue, can I help?

@anle9650
Copy link
Contributor

anle9650 commented Dec 27, 2023

Here are the components I've found that seem to lack clear documentation for complementary components:

@samuelsycamore samuelsycamore added the ready to take Help wanted. Guidance available. There is a high chance the change will be accepted label Dec 27, 2023
@samuelsycamore
Copy link
Member Author

Thanks for investigating this @anle9650 !! I've added the ready to take tag in case anybody else wants to pitch in and document some of these.

@DiegoAndai
Copy link
Member

Created an issue for the tabs complementary components: #40558

@DiegoAndai
Copy link
Member

An issue was created for the Stepper complementary components: #41454

@samuelsycamore
Copy link
Member Author

@anle9650 reviewing the list above again, I think we can drop Snackbar — <SnackbarContent /> is documented under "Content" on that page, and it's an optional component so not necessary for implementation.

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 package: material-ui Specific to @mui/material ready to take Help wanted. Guidance available. There is a high chance the change will be accepted support: docs-feedback Feedback from documentation page
Projects
None yet
Development

No branches or pull requests

4 participants