[docs] Standardize getting started docs across all packages #16302
Conversation
mapache-salvaje
added
docs
|
Deploy preview: https://deploy-preview-16302--material-ui-x.netlify.app/ Updated pages: |
mapache-salvaje
requested review from
flaviendelangle,
LukasTy,
KenanYusuf,
michelengelen,
alexfauquette and
alelthomas
| - https://mui.com/x/react-charts/getting-started/ | ||
| - https://mui.com/x/react-data-grid/#premium-plan | ||
| - https://mui.com/x/react-data-grid/getting-started/ | ||
| - https://mui.com/x/react-data-grid/getting-started/#feature-comparison | ||
| - https://mui.com/x/react-date-pickers/fields/#accessible-dom-structure | ||
| - https://mui.com/x/react-date-pickers/getting-started/ | ||
| - https://mui.com/x/react-tree-view/#rich-tree-view | ||
| - https://mui.com/x/react-tree-view/#simple-tree-view | ||
| - https://mui.com/x/react-tree-view/getting-started/ |
There was a problem hiding this comment.
As I understand things, we should fix those
| - https://mui.com/x/react-charts/getting-started/ | |
| - https://mui.com/x/react-data-grid/#premium-plan | |
| - https://mui.com/x/react-data-grid/getting-started/ | |
| - https://mui.com/x/react-data-grid/getting-started/#feature-comparison | |
| - https://mui.com/x/react-date-pickers/fields/#accessible-dom-structure | |
| - https://mui.com/x/react-date-pickers/getting-started/ | |
| - https://mui.com/x/react-tree-view/#rich-tree-view | |
| - https://mui.com/x/react-tree-view/#simple-tree-view | |
| - https://mui.com/x/react-tree-view/getting-started/ |
There was a problem hiding this comment.
They're all coming from the Material UI docs and MUI blog - PR to fix them here: mui/material-ui#45145
There was a problem hiding this comment.
Ah, thanks for the context. This seems related to mui/base-ui#552.
| { pathname: '/x/react-data-grid/quickstart', title: 'Quickstart' }, | ||
| { pathname: '/x/react-data-grid/features', title: 'Features' }, |
There was a problem hiding this comment.
Nitpick: Explicit title is not needed if it aligns with the path/slug. 😉
On that same note: have you considered only renaming the title, but keeping the existing pathnames?
We would avoid the URL changes, redirects, and maybe even some SEO implications... 🤷 🙈
| { pathname: '/x/react-data-grid/quickstart', title: 'Quickstart' }, | |
| { pathname: '/x/react-data-grid/features', title: 'Features' }, | |
| { pathname: '/x/react-data-grid/quickstart' }, | |
| { pathname: '/x/react-data-grid/features' }, |
There was a problem hiding this comment.
Yeah I was on the fence about changing the path names and originally planned to leave them alone. I just figured it would be more annoying for maintainers in the future if they're looking for a page called "Features" (for example) but all the related files are called "Demo."
There was a problem hiding this comment.
Gotcha. Well, if no one sees problems (SEO) with redirects, I'm all for this. 🙌
github-actions
bot
added
the
PR: out-of-date
|
This pull request has conflicts, please resolve those before we can evaluate the pull request. |
Co-authored-by: Alexandre Fauquette <[email protected]> Co-authored-by: Lukas Tyla <[email protected]> Signed-off-by: Sam Sycamore <[email protected]>
github-actions
bot
removed
the
PR: out-of-date
mapache-salvaje
requested review from
alexfauquette,
LukasTy and
oliviertassinari
Follow-up to #15757, applying the same patterns from the Data Grid getting started docs to the other X components for a more consistent and predictable experience.
With this PR, all 4 packages now have 2 pages in the Getting Started sequence:
Considerations:
Questions:
Notes: