[docs][data grid] Revise server-side data docs #17007
Conversation
mapache-salvaje
added
docs
|
Thanks for adding a type label to the PR! 👍 |
|
Deploy preview: https://deploy-preview-17007--material-ui-x.netlify.app/ Updated pages: |
mapache-salvaje
added
scope: data grid
mapache-salvaje
added
docs
mapache-salvaje
requested review from
MBilalShafi,
arminmeh,
michelengelen and
alelthomas
| - https://mui.com/x/react-data-grid/row-grouping/#disable-the-row-grouping | ||
| - https://mui.com/x/react-data-grid/server-side-data/#updating-data |
There was a problem hiding this comment.
these are links in the MUI blog
|
|
||
| To dynamically load tree data from the server, you must create a data source and pass the `dataSource` prop to the Data Grid, as detailed in the [Server-side data overview](/x/react-data-grid/server-side-data/). | ||
| ## Server-side aggregation |
There was a problem hiding this comment.
For my knowledge, are we updating the convention here to repeat the page name as first heading? To me, it looks a bit redundant, the same text twice next to each other.
There was a problem hiding this comment.
You're right, I don't love these either. I felt like the pages needed something for an h2 here, mostly for navigation purposes. I don't like repeating "Overview" or "Introduction" on every page but not sure what else to write here.
There was a problem hiding this comment.
In such cases, directly starting relevant content below h1, like this, looks like a reasonable middle ground to me.
Obviously, we could add headings like "Introduction" or "Overview" where relevant, but trading off the duplicate heading with one less navigation link sounds a reasonable compromise, until we come up with a more concrete way to approach this.
Wdyt?
There was a problem hiding this comment.
Good call. I guess what I'm really feeling is the need for an infra solution like what Base UI has with (Top) in the TOC:
There was a problem hiding this comment.
Yes, I also had something similar in mind. That'd be nice to do on an infra level.
There was a problem hiding this comment.
| ## Server-side tree data | ||
|
|
||
| Trees are hierarchical data structures that organize data into parent-child relationships. | ||
| The Data Grid Pro can handle server-side tree data to render grouped rows with nested children using the [Data Source layer](/x/react-data-grid/server-side-data/#the-solution-the-data-source-layer). |
There was a problem hiding this comment.
I wonder if the icon is not enough to convey which plan a feature falls under. If not, should we repeat the plan information for the rest of the commercial features too?
There was a problem hiding this comment.
That's probably a good idea. Maybe an info or success callout at the top of the Pro and Premium pages to note that they require a paid license and link to the licensing page? (I can open a separate PR to address all of the licensed feature pages together.)
Co-authored-by: Bilal Shafi <[email protected]> Signed-off-by: mapache-salvaje <[email protected]>
Co-authored-by: Michel Engelen <[email protected]> Signed-off-by: mapache-salvaje <[email protected]>
parallel description structure Signed-off-by: mapache-salvaje <[email protected]>
mapache-salvaje
added
the
needs cherry-pick
mapache-salvaje
removed
the
needs cherry-pick
This PR thoroughly revises all 5 pages in the Data Grid's server-side data docs to bring consistency to the copy, improve the structure, style, and grammar, and provide more context and details throughout.
Part of the ongoing auditing/editing project, prioritizing Premium and Pro feature pages.