[CONTRIBUTING] Document starting the documentation sooner

I’m struggling to figure out how to get a dev instance of MUI running on my local machine.

Context: It all started from this question I asked on StackOverflow.

So far I’ve run the yarn start from the documentation site, which does run the site… but when, for example I try to add a new sub section under pages > customisation > variants (this is new) . Hitting the url alway results in a 404.

• [x ] I have searched the issues of this repository and believe that this is not a duplicate.

Summary 💡

My issue is 2 fold, I’d like to actually solve the issue below. (I’m happy to do the work myself, except I’m not sure how to get a dev MUI project running and all the pieces working together)

I’d want to get a proof of concept working where I can have a component use a custom variant & palette. like this. The problem, custom palette values seem to be ignored when using a custom variant too

<Button variant="MyCompaniesVariant" color="focus" />
<Button variant="MyCompaniesVariant" color="muted" size="large" />

https://codesandbox.io/s/globalthemevariants-material-demo-forked-qxjb3?file=/eleMuiGlobals/variant-extensions.ts

Motivation 🔦

I’m trying to get a small enhancement into a local copy of MUI to see how / if this would be possible.

Question

I looked through the MUI code base, but I’m either a little blind, or stupid / both 😛 But I’m not able to figure out the dev workflow. What do I need to do to “get up and running”.

[rohan-buchner]

@mnajdova I got it! Thank you! (Still a little new to some of the more advanced MUI usages) But that but that updated sandbox you’ve created helped tremendously. Thank you so much.

[oliviertassinari]

It seems that the different concerns were addressed, (this issue bundle a lot of different topics). I have renamed it to focus on one actionable item: how to start the documentation as one of the first steps: https://github.com/mui-org/material-ui/issues/23757#issuecomment-735400685.

@hmaddisb we try to keep pull requests focusing on a single problem at a time. In this case, It’s probably best to have two different pull requests as they can land independently.