[docs][data grid] Revise the Data Grid getting started docs #15757
Conversation
Signed-off-by: Sycamore <[email protected]>
mapache-salvaje
requested review from
KenanYusuf,
cherniavskii,
michelengelen and
alelthomas
|
|
||
| ```tsx | ||
| // Pro and Premium users: add `-pro` or `-premium` suffix to package name |
There was a problem hiding this comment.
I'm still on the fence about which is preferable:
- list all three imports? (annoying for copy+paste)
- only include Community version? (could be unclear or just a minor annoyance for paid users)
There was a problem hiding this comment.
Not for this PR, but I was wondering if we could improve the overall experience of the Data Grid docs by having a plan switcher. Something like this, but it would apply to all of the snippets (and maybe demos) to only show the package that the user is interested in:
Screen.Recording.2025-01-16.at.14.29.08.mov
There was a problem hiding this comment.
Yeah that would be nice to have!
mapache-salvaje
added
type: enhancement
| - https://mui.com/x/react-data-grid/#premium-plan | ||
| - https://mui.com/x/react-data-grid/getting-started/#feature-comparison |
There was a problem hiding this comment.
To revert, this is wrong, those links are broken.
| - https://mui.com/x/react-data-grid/#premium-plan | |
| - https://mui.com/x/react-data-grid/getting-started/#feature-comparison |
There was a problem hiding this comment.
I believe these are links from the @mui/material repo in the blog. I'll open a PR there to address them.
|
|
||
| Please see [the Licensing page](/x/introduction/licensing/) for details. | ||
|
|
||
| ## Features |
There was a problem hiding this comment.
Unless we have something more sophisticated like https://deploy-preview-15757--material-ui-x.netlify.app/x/react-date-pickers/, it looks like we need to restore this list, no? How do we keep visitors to continue considering the component without overwhelming them with docs info otherwise?
There was a problem hiding this comment.
Before this PR there were 3 different feature lists: on the Overview, Getting Started, and Demo pages. I really don't think there should be more than 1 list. I renamed Demo to Feature Showcase to try to make it the single source of truth for features. One thing I considered was to merge the Feature Showcase demo into the Overview page. What do you think about that? Since this page will likely get a design upgrade like what was done for the Date and Time Pickers, we might want to just keep it simple with the copy for now.
|
|
||
| If you still have trouble, you can refer to the [support page](/x/introduction/support/). | ||
|
|
||
| ## How to pass props to the Data Grid for better performance? |
There was a problem hiding this comment.
Nice to see the FAQ size shrunk 👍. FAQs are usually about giving up on finding a great docs architecture to place the information in the right place.
I don't know if we need to kill thoughts because they are things that we don't want people to be able to find (noise) unless they do an explicit search for it. To consider for the future if we find a use case.
There was a problem hiding this comment.
FAQs are usually about giving up on finding a great docs architecture to place the information in the right place.
This is how the MUI X FAQs felt to me, which is why I made it a priority to relocate all of that content. I would honestly be surprised if we could find a worthwhile use case for this page in the future. I think I would always prefer to find (or create) a more specific place for any new content. As technical writers, we should be able to anticipate the questions that users will have and address them in the same docs where those questions might arise, rather than gathering unsorted answers to random questions in a catch-all FAQ doc. Not to say there's never a use for FAQs, I just don't really see the utility in this context.
Signed-off-by: Sycamore <[email protected]>
WIP
Closes #15719
Thorough revision of the Data Grid Getting Started docs and a few other pages where content has been rearranged:
renderCell(),valueGetter(), andvalueFormatter()