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] Improve installation instructions for running the docs locally #15608

Merged
merged 2 commits into from May 7, 2019
Merged

[docs] Improve installation instructions for running the docs locally #15608

merged 2 commits into from May 7, 2019

Conversation

andreawaxman
Copy link
Contributor

@andreawaxman andreawaxman commented May 6, 2019 •
edited

I updated the installation instructions on the README file to clarify some things after:

  1. Trying and failing to install the Yarn dependencies due to my outdated OS.
  2. When testing to add a feature request, my colleague who is also working on this project, ran into issues when using NPM on Mac, therefore I clarified that one should only use Yarn for installation and testing for things to run smoothly.

@mui-pr-bot
Copy link

mui-pr-bot commented May 6, 2019 •
edited

No bundle size changes comparing bb5b5b4...ece9702

Generated by 🚫 dangerJS against ece9702

oliviertassinari
oliviertassinari reviewed May 6, 2019
View reviewed changes
docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label May 6, 2019
@oliviertassinari oliviertassinari changed the title updated README.md [docs] Improve installation instructions for running the docs locally May 7, 2019
@oliviertassinari oliviertassinari merged commit 1458ab5 into mui:next May 7, 2019
@oliviertassinari
Copy link
Member

oliviertassinari commented May 7, 2019 •
edited

@andreawaxman Thank you! We do our best to minimize the cost of new contributions, this is going in the right direction 💯 .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@oliviertassinari oliviertassinari oliviertassinari approved these changes

@joshwooding joshwooding joshwooding left review comments

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.

None yet
4 participants
@andreawaxman @mui-pr-bot @oliviertassinari @joshwooding