-
-
Notifications
You must be signed in to change notification settings - Fork 121
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.
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
docs: add instructions for opening/repositioning devtools #528
base: main
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for vue-devtools-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
docs/getting-started/features.md
Outdated
@@ -1,6 +1,6 @@ | |||
# Features | |||
|
|||
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 the Vue DevTools window. | |||
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 the Vue DevTools window. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
double "the"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the catch. You'll have to forgive me; I was drunk when I did this and for the entire time since.
Fixed!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
no biggy.
maybe don't get drunk so you don't have to make excuses?
Cheers!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, >hic!< that's a >hic!< pretty good idea! But in the morning I'll be sober, and you, uh, zzzzzzzzz
Remove double-"the"
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. |
@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? |
@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".) |
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.