[docs] Improve the Getting Started documentation content #30808
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
mnajdova
commented
Jan 27, 2022
mnajdova
commented
- I have followed (at least) the PR section of the contributing guide.
mnajdova
commented
Jan 27, 2022
| @@ -177,10 +177,6 @@ const StyledSlider = styled(Slider, { | |||
|
|
|||
| {{"demo": "pages/customization/how-to-customize/DynamicCSSVariables.js"}} | |||
|
|
|||
| ### Theme nesting | |||
There was a problem hiding this comment.
We shouldn't recommend using nested themes for changing the look of the component based on prop. It is misleading. The nested theme has a different purpose, and it is described on different pages.
mnajdova
commented
Jan 27, 2022
| @@ -225,7 +221,3 @@ If you are already using the [CssBaseline](/components/css-baseline/) component | |||
| ) | |||
| } | |||
| ``` | |||
|
|
|||
| ## 6. Custom class name | |||
There was a problem hiding this comment.
It's not relevant here.
mnajdova
commented
Jan 27, 2022
| }, | ||
| }); | ||
| ``` | ||
| Think of creating a theme as a two-step composition process: first, you define the basic design options; then, you'll use these design options to compose other options. |
There was a problem hiding this comment.
We support now callbacks in the styleOverrides this is not an issue anymore.
mnajdova
commented
Jan 27, 2022
| @@ -52,6 +52,7 @@ If you want to start with a more complete and real-world example, you could take | |||
| - All PWA features included (SW, Notifications, deferred installation prompt and more) | |||
| - Optimized and scalable performance (all ~100 points on Lighthouse) | |||
|
|
|||
| <!-- TODO: revert this once it is migrated to v5 | |||
There was a problem hiding this comment.
It's still using v4, we should not link it until it is upgraded. It is misleading for people first coming to the documentaiton.
mnajdova
commented
Jan 27, 2022
|
|
||
| <!-- TODO: revert this once it is migrated to v5 |
There was a problem hiding this comment.
Same here, still depends on v4.
mnajdova
commented
Jan 27, 2022
| - [Material Sense](https://github.com/alexanmtz/material-sense): | ||
|
|
||
| -  | ||
| - Graph using recharts | ||
| - React Router included with a navigation example | ||
| - A docker container with an Nginx server for production build | ||
| - Created with Create React App | ||
|
|
||
| - [RMUIF](https://github.com/rmuif/web): |
There was a problem hiding this comment.
Not maintained anymore, depends on v4.
mnajdova
commented
Jan 27, 2022
mnajdova
commented
Jan 27, 2022
| @@ -20,6 +20,8 @@ This [selection of basic templates](/getting-started/templates/) will help you g | |||
|
|
|||
| ## Recommended resources | |||
|
|
|||
| > ⚠️ Note that the resources linked below are using MUI v4, which is not the latest major version. As v5 was released recently, it would take some time till new content is created. If you have created some learning material for v5, let us know and we can link them here. | |||
There was a problem hiding this comment.
Hopefully we will have more content related to v5 soon
siriwatknp
approved these changes
Jan 28, 2022
hbjORbj
reviewed
Jan 28, 2022
hbjORbj
reviewed
Jan 28, 2022
hbjORbj
reviewed
Jan 28, 2022
hbjORbj
reviewed
Jan 28, 2022
Co-authored-by: Benny Joo <[email protected]>
Co-authored-by: Benny Joo <[email protected]>
Co-authored-by: Benny Joo <[email protected]>
hbjORbj
approved these changes
Jan 28, 2022
wladimirguerra
pushed a commit
to wladimirguerra/material-ui
that referenced
this pull request
Feb 2, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.