Skip to content

Commit 6cdacdf

Browse files
committed
Moving usage to the end of each installation guide.
1 parent 0201042 commit 6cdacdf

File tree

4 files changed

+33
-11
lines changed

4 files changed

+33
-11
lines changed

docs/getting-started/features.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# Features
22

3-
After installation, you should see a small icon with the "Vue" logo at the bottom center of your screen. Clicking this (or pressing the "Toggle Vue DevTools" hotkey -- check your startup logs) will open the Vue DevTools window.
4-
5-
The Vue DevTools can be repositioned by dragging this icon.
3+
Below is a list of all the features and functionality of Vue DevTools.
64

75
## Overview
86

docs/guide/browser-extension.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,11 @@
44
The v7 version of detools only supports Vue3. If your application is still using Vue2, please install the [v6 version](https://chromewebstore.google.com/detail/vuejs-devtools/nhdogjmejiglipccpnnnanhbledajbpd?utm_source=ext_sidebar).
55
:::
66

7-
## Chrome
7+
## Installation
8+
9+
Installation of the browser extension differs from browser to browser.
10+
11+
### Chrome
812

913
The extension is in beta, remove or disable any existing versions and install the extension from [here](https://chromewebstore.google.com/detail/vuejs-devtools-beta/ljjemllljcmogpfapbkkighbhhppjdbg?utm_source=ext_sidebar).
1014

@@ -24,7 +28,7 @@ The extension is in beta, remove or disable any existing versions and install th
2428
</a>
2529
</div>
2630

27-
## Edge (Arc/Brave)
31+
### Edge (Arc/Brave)
2832

2933
...and other Chromium-based browsers.
3034

@@ -46,6 +50,12 @@ This is the same as the Chrome extension, but you need to install it from the Ch
4650
</a>
4751
</div>
4852

49-
## Firefox
53+
### Firefox
5054

5155
We'll launch on the Firefox App Store once v7.0 is stable.
56+
57+
## Usage
58+
Once installed as a browser extension, Vue DevTools can be found within your browser's Developer Tools. These can typically be opened using `Ctrl+Shift+I` or `F12` depending on
59+
your browser and operating system.
60+
61+
Within your browser's Developer Tools, you should see a new tab at the top that reads "Vue". Keep in mind that it may be hidden within a dropdown if there are many tabs.

docs/guide/standalone.md

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ $ bun add -D @vue/devtools@next
5050

5151
:::
5252

53-
## Usage
53+
## Starting the Standalone App
5454

5555
### Using global package
5656

@@ -60,7 +60,7 @@ Once you installed the package globally, run:
6060
vue-devtools
6161
```
6262

63-
Then add this code to the `<head>` section of your application HTML file:
63+
This will start up the Standalone App. Then add this code to the `<head>` section of your application HTML file:
6464

6565
```html
6666
<script src="http://localhost:8098"></script>
@@ -85,12 +85,14 @@ Or if you want to debug your device remotely:
8585

8686
### Using dependency package
8787

88-
Once you installed the package as project dependency, run:
88+
If you've installed the package as a project dependency, run:
8989

9090
```sh
9191
./node_modules/.bin/vue-devtools
9292
```
9393

94+
This will start up the Standalone App.
95+
9496
:::tip
9597
You can also use the global `vue-devtools` to start the app, but you might want to check if the local version matches the global one in this scenario to avoid any incompatibilities.
9698
:::
@@ -116,6 +118,12 @@ Make sure to invoke devtools connect function before creating Vue App, otherwise
116118

117119
**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.
118120

121+
## Usage
122+
123+
The Standalone App must be manually opened from the command line each time you want to start using it (see above).
124+
125+
It will stay accessible in a regular application window on your desktop until closed.
126+
119127
## FAQ
120128

121129
### 1. How to change port devtools server is running on?

docs/guide/vite-plugin.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ $ bun add -D vite-plugin-vue-devtools
2828

2929
:::
3030

31-
## Usage
31+
## Setup
3232

3333
```ts
3434
// Configuration Vite
@@ -43,7 +43,13 @@ export default defineConfig({
4343
})
4444
```
4545

46-
## Options
46+
## Usage
47+
48+
If the Vite Plugin has been installed and setup correctly, you should see a small icon with the "Vue" logo at the bottom center of your screen. Clicking this (or pressing the "Toggle Vue DevTools" hotkey -- check your startup logs) will open the Vue DevTools window.
49+
50+
The Vue DevTools can be repositioned by dragging this icon.
51+
52+
## Configuration Options
4753

4854
```ts
4955
interface VitePluginVueDevToolsOptions {

0 commit comments

Comments
 (0)