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.

Sign up for GitHub

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

Jump to bottom

[docs] Add information about local dev environment #24771

Merged
merged 2 commits into from
Feb 4, 2021
Merged

[docs] Add information about local dev environment #24771

merged 2 commits into from
Feb 4, 2021

Conversation

plug-n-play
Copy link
Contributor

@plug-n-play plug-n-play commented Feb 4, 2021 •
edited
Loading

The heading and contents do not currently rightly reflect docs site to be the playground for making changes in core components apart from docs. This should hopefully be more clearer.

@plug-n-play
Adding information about local dev environment
7d925e2 
The heading and contents do not currently rightly reflect docs site to be the playground for making changes in core components apart from docs. This should hopefully be more clearer.
@plug-n-play
Copy link
Contributor Author

Hopefully this change would help doubts like #24770

@mui-pr-bot
Copy link

mui-pr-bot commented Feb 4, 2021 •
edited
Loading

No bundle size changes

Generated by 🚫 dangerJS against 5403cf7

@oliviertassinari oliviertassinari changed the title Adding information about local dev environment [docs] Add information about local dev environment Feb 4, 2021
@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Feb 4, 2021
@oliviertassinari oliviertassinari merged commit f0e657b into mui:next Feb 4, 2021
@oliviertassinari
Copy link
Member

@plug-n-play Thanks for the suggestion, I have adjusted it to provide more details.

@plug-n-play
Copy link
Contributor Author

Thanks @oliviertassinari
I would still recommend adding verbiage in heading similar to Local Dev Environment may be along with existing heading at https://github.com/mui-org/material-ui/blob/next/CONTRIBUTING.md#trying-changes-on-the-documentation-site - As of now the existing heading suggests that the section is just about getting Docs project up and running locally. With this change, it would help anyone looking for where and how to start the local dev setup. Cheers.

@oliviertassinari
Copy link
Member

@plug-n-play Thanks for the suggestion, I have taken it into account but went against it. The documentation is paramount, we can't adapt to this perspective.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
docs Improvements or additions to the documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@plug-n-play @mui-pr-bot @oliviertassinari