8000 docs: Update Local_Development.mdx by Zamiell · Pull Request #7395 · typescript-eslint/typescript-eslint · GitHub
[go: up one dir, main page]
Skip to content

docs: Update Local_Development.mdx #7395

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

Closed
wants to merge 2 commits into from
Closed

docs: Update Local_Development.mdx #7395

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
99c5e57
Update Local_Development.mdx
Zamiell Aug 1, 2023
a27b5ae
Update Local_Development.mdx
Zamiell Aug 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions docs/contributing/Local_Development.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,16 @@ You can run `yarn typecheck` in any package or in the root to run `tsc`.
## Website Development

Our interactive documentation website is built with [Docusaurus](https://docusaurus.io).
Running `yarn start` from either the root or `packages/website` will start a local dev server on `localhost:3000`.

> The `website` package relies on other packages being built.
> We recommend running `yarn build` from the root before `yarn start`.
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`.
Comment on lines +89 to +93
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the existing text better as it doesn't assume that someone has read a disparate section of the docs.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In theory, you can't skip the setup.

Copy link
Contributor Author
@Zamiell Zamiell Aug 1, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes you can - you can be directly linked to this section or be warped to this section from the Algolia search bar.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this case, we should just say "remember to run the setup steps at the top of the page".

cd packages/website-eslint
yarn build
cd ../..
cd packages/website
yarn build
cd ../..
```
Next, running `yarn start` from either the root or `packages/website` will start a local dev server on `localhost:3000`.
0