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

[docs][data grid] Revise the Data Grid getting started docs #15757

Merged
merged 44 commits into from
Jan 20, 2025

Conversation

mapache-salvaje
Copy link
Contributor

@mapache-salvaje mapache-salvaje commented Dec 5, 2024

WIP

Closes #15719

Thorough revision of the Data Grid Getting Started docs and a few other pages where content has been rearranged:

  • removes redundant information spread across multiple pages
  • clarifies purpose of each page in the sequence
  • rewrites content for clarity, accuracy, and completeness
  • removes FAQ page by moving content to more specific locations
    • introduces "Cells" page for content comparing renderCell(), valueGetter(), and valueFormatter()
    • updates "Performance" page to match style guidelines
  • renames "Demo" (vague) page to "Feature showcase" (more clear)
  • renames "Getting started" (term already in use for other UX writing in the docs) page to "Quickstart" (more accurate and easily understood by devs)
  • general copyediting throughout all of the pages touched

@mapache-salvaje mapache-salvaje added the docs Improvements or additions to the documentation label Dec 5, 2024
@mapache-salvaje mapache-salvaje marked this pull request as ready for review January 15, 2025 20:20

```tsx
// Pro and Premium users: add `-pro` or `-premium` suffix to package name
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah that would be nice to have!

@mapache-salvaje mapache-salvaje added enhancement This is not a bug, nor a new feature component: data grid This is the name of the generic UI component, not the React module! labels Jan 15, 2025
@mapache-salvaje mapache-salvaje merged commit d10486f into mui:master Jan 20, 2025
18 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: data grid This is the name of the generic UI component, not the React module! docs Improvements or additions to the documentation enhancement This is not a bug, nor a new feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[docs][data grid] Revise the Data Grid getting started sequence
5 participants