Skip to content

Commit

Permalink
docs: link update + setup steps improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
Akryum committed Oct 8, 2022
1 parent 7684ad6 commit 67580d1
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions packages/docs/src/guide/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ The repository is a monorepo with several nested packages:

## Development

1. Clone this repo
2. run `yarn install`
3. then run `yarn run build:watch` and `yarn run dev:vue3` in parallel
4. A plain shell with a test app will be available at `localhost:8090`.
1. Clone [this repo](https://github.com/vuejs/devtools)
2. Run `yarn install` in the repository root to install dependencies.
3. Run `yarn run build:watch` (compiles and watch the packages) and then `yarn run dev:vue3` (run the development shell) in two different terminals. Wait for the initial compilation in the first terminal to finish before running the second command.
4. A plain shell with a test app will be available at `http://localhost:8090`.

## Pull Request Guidelines

Expand Down
4 changes: 2 additions & 2 deletions packages/docs/src/guide/faq.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Frequently Asked Questions

## How to use the devtools in IE/Edge/Safari or any other browser?
## How to use the devtools in IE/Safari or any other browser?

In case your browser doesn't have our browser extension available, we made a standalone Vue devtools application.
[Get it now!](./installation.md#standalone)
Expand All @@ -17,7 +17,7 @@ Here are some troubleshooting steps to help you if you don't the Vue devtools in
- Check if you have the extension [installed](./installation.md).
- If you are on a live website, there is a good chance it's using a production build of Vue.
- Use a non-minified, non-`prod` version of Vue on CDN
- Set the `__VUE_PROD_DEVTOOLS__` environment variable for Vue 3 when using a bundler like Webpack ([more info](https://github.com/vuejs/vue-next/tree/master/packages/vue#bundler-build-feature-flags)).
- Set the `__VUE_PROD_DEVTOOLS__` environment variable for Vue 3 when using a bundler like Webpack ([more info](https://github.com/vuejs/core/tree/main/packages/vue#bundler-build-feature-flags)).
- Try closing the devtools pane, refreshing the page and opening the devtools pane again.
- Try restarting the browser or the computer.
- If you have multiple versions of the Vue devtools installed, it's recommended to disable/remove the others.
Expand Down
4 changes: 2 additions & 2 deletions packages/docs/src/guide/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,11 +183,11 @@ if (process.env.NODE_ENV === 'development') {

**port** - is an optional argument that tells your application on what port devtools middleware server is running. If you use proxy server, you might want to set it to `null` so the port won't be added to connection URL.

[More details](https://github.com/vuejs/vue-devtools/tree/dev/packages/shell-electron#vue-remote-devtools)
[More details](https://github.com/vuejs/devtools/tree/main/packages/shell-electron#vue-remote-devtools)

## Legacy

If something is broken with the new devtools, please [submit a new issue](https://new-issue.vuejs.org/?repo=vuejs/devtools)!
If something is broken with the new devtools, please [submit a new issue](https://github.com/vuejs/devtools/issues/new/choose)!

Meanwhile, you can install the legacy version (v5) of the devtools:

Expand Down

0 comments on commit 67580d1

Please sign in to comment.