search

vuejs / devtools

⚙️ Browser devtools extension for debugging Vue.js applications.
https://devtools.vuejs.org/
MIT License
1.7k stars 122 forks source link

docs: add instructions for opening/repositioning devtools #528

Open Offlein opened 4 months ago

Offlein commented 4 months ago

I just waited a bunch of time trying to figure out something that should be pretty fundamental to usage. In my opinion the docs should start with this text.

(Removes "Discover all the features of the Vue DevTools" which feels like placeholder text anyway to have something before the first subheading.)

It would be nice to include the shortcut keys here but I know there's handling for Mac/non-Mac keyboards so I dunno how people would like that handled.

netlify[bot] commented 4 months ago

Deploy Preview for vue-devtools-docs ready!

Name Link
Latest commit 6cdacdf1559761ead52df02e45cebe33228f4ac6
Latest deploy log https://app.netlify.com/sites/vue-devtools-docs/deploys/66cfaad04357d800084c0294
Deploy Preview https://deploy-preview-528--vue-devtools-docs.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

webfansplz commented 3 months ago

Thanks for the PR, but I'm not so sure about it. The tips we added here only apply to the Vite plugin, but we also have a browser extension and standalone app client... This may be confusing for users.

Offlein commented 3 months ago

@webfansplz Yes, thanks; in that way, I agree.

It seems like this could be solved by just moving this into the "Overview" section with a little caveat, e.g. "If you are using the plugin, DevTools will start at the bottom of your screen but you can move it, yadda yadda."

What do you think about that?

Offlein commented 2 months ago

@webfansplz I have moved the usage out of the "Features" section and put it at the end of each Installation guide. I also clarified some minor things in those guides. (For instance, in my opinion the verbiage was strange; the instructions for configuring your Vite Plugin were called "Usage".)