Skip to content
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

Add relevant help tooltips or docs links within widgets #1146

Open
jartuso opened this issue Jun 22, 2023 · 2 comments
Open

Add relevant help tooltips or docs links within widgets #1146

jartuso opened this issue Jun 22, 2023 · 2 comments

Comments

@jartuso
Copy link
Contributor

jartuso commented Jun 22, 2023

Is your feature request related to a problem? Please describe.

Brand new users of the GUI may not know where to go to find documentation. People can be pretty lazy or may not think to go read the docs. Adding tooltips could help reduce the amount of support tickets from confused 1st time users.

For example -- The NeuroFly EMG Joystick comes with an EMG Settings widget. As a 1st time user, I didn't know what the various EMG settings did and I didn't know (forgot) that it was already well-documented here

Describe the solution you'd like

Add a (?) icon to each widget that includes a link to the relevant section of the OpenBCI docs.

Describe alternatives you've considered

A single catch-all documentation link.
Adding tooltip text that explain things within the GUI, rather than linking out to do the docs

Additional context

@bobthefairycat
Copy link

If this is going to be implemented, I think users should be given an option at first startup or the like to enable or disable tooltips. I personally abhor tooltips.

@retiutut retiutut added this to the GUI Maintenance FY23 Q2 milestone Jun 27, 2023
@retiutut retiutut self-assigned this Jun 27, 2023
@retiutut
Copy link
Member

Great feedback! Prioritizing this. I also like the idea to somehow hide what would be buttons for experienced users.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants