-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
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] Revise and split up "Overview" page into "Introduction" section #4692
[docs] Revise and split up "Overview" page into "Introduction" section #4692
Conversation
These are the results for the performance tests:
|
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure why, but the doc switcher widget at the top of the nav bar isn't showing up on the new pages I created. Maybe someone can help me figure out how to make it come back? 😅
I think you have old dependencies. Try switching to master
and run git pull
, then go back to this branch, run git merge master
and commit.
@m4theushw @samuelsycamore I would wait with this until mui/material-ui#32552 is merged, otherwise |
Ok, it needs a change in the core repo right here: diff --git a/docs/src/modules/components/AppNavDrawer.js b/docs/src/modules/components/AppNavDrawer.js
index 2e5f8225f05..07c1b4fec9f 100644
--- a/docs/src/modules/components/AppNavDrawer.js
+++ b/docs/src/modules/components/AppNavDrawer.js
@@ -653,7 +653,7 @@ export default function AppNavDrawer(props) {
])}
/>
)}
- {asPathWithoutLang.startsWith('/x/advanced-components') && (
+ {asPathWithoutLang.startsWith('/x/getting-started') && (
<ProductIdentifier name="Advanced components" metadata="MUI X" />
)} I can open a PR addressing this or feel free to open one if you want :) Lines 2602 to 2604 in cfc9a6f
|
Co-authored-by: Andrew Cherniavskii <[email protected]>
This pull request has conflicts, please resolve those before we can evaluate the pull request. |
@cherniavskii for the monorepo PR to fix the link, we can avoid temporarily breaking stuff by just handling both links starting now and remove the legacy one later - {asPathWithoutLang.startsWith('/x/advanced-components') && (
+ {(asPathWithoutLang.startsWith('/x/advanced-components') || asPathWithoutLang.startsWith('/x/getting-started')) && ( |
I've opened mui/material-ui#32657 to address missing product identifier component |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great job @oliviertassinari! I think this is basically ready to go. 👍
- [`@mui/x-data-grid-premium`](https://www.npmjs.com/package/@mui/x-data-grid-premium) | ||
|
||
:::info | ||
The features exclusive to the Premium version are marked with the <span class="plan-premium"></span> icon throughout the documentation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we add an example image like we do for pro ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actually I'm thinking we should remove the screenshot from the Pro section—I don't think it really adds any value.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could also make sense, or just inline an example if it's worth it
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is looking great!
We can merge this to have it published with the next release.
And we can create new PRs for any other improvements.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done as far as I'm concerned (sorry, haven't read it again).
Merging in 3, 2, 1... |
mui#4692) Co-authored-by: Andrew Cherniavskii <[email protected]> Co-authored-by: José Rodolfo Freitas <[email protected]> Co-authored-by: Matt <[email protected]> Co-authored-by: Olivier Tassinari <[email protected]> Co-authored-by: Matheus Wichman <[email protected]> Co-authored-by: Flavien Delangle <[email protected]>
mui#4692) Co-authored-by: Andrew Cherniavskii <[email protected]> Co-authored-by: José Rodolfo Freitas <[email protected]> Co-authored-by: Matt <[email protected]> Co-authored-by: Olivier Tassinari <[email protected]> Co-authored-by: Matheus Wichman <[email protected]> Co-authored-by: Flavien Delangle <[email protected]>
Doc preview: https://deploy-preview-4692--material-ui-x.netlify.app/
This PR revises and splits up the content on the Overview page.
Follow up to: Add and/or revise "Overview" pages for each MUI product
The new Introduction section features 5 pages:
I rewrote the content on the Overview page to match the formatting of the Base Overview page.