docs: Update Local_Development.mdx #7395
Conversation
|
Thanks for the PR, @Zamiell! typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community. The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately. Thanks again! 🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| After cloning the repository, run the following steps to install and build the website: | ||
|
|
||
| ```sh | ||
| yarn install # To ensure that the dependencies are installed. | ||
| yarn build # This builds all the packages except for `website-eslint` and `website`. |
There was a problem hiding this comment.
| After cloning the repository, run the following steps to install and build the website: | |
| ```sh | |
| yarn install # To ensure that the dependencies are installed. | |
| yarn build # This builds all the packages except for `website-eslint` and `website`. | |
| Before running `yarn start` you have to execute the following commands to build the necessary packages: | |
| ```sh |
There was a problem hiding this comment.
I like the existing text better as it doesn't assume that someone has read a disparate section of the docs.
There was a problem hiding this comment.
In theory, you can't skip the setup.
There was a problem hiding this comment.
Yes you can - you can be directly linked to this section or be warped to this section from the Algolia search bar.
There was a problem hiding this comment.
In this case, we should just say "remember to run the setup steps at the top of the page".
PR Checklist
Overview
Making docs more explicit. Future PRs should add better error messages to make reading the docs unnecessary.