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

Neuroscout tour + tooltips in Builder #607

Merged
merged 13 commits into from Jul 8, 2019
Merged

Neuroscout tour + tooltips in Builder #607

merged 13 commits into from Jul 8, 2019

Conversation

adelavega
Copy link
Collaborator

I was thinking about how to document Neuroscout, and I realized that I personally never read frontend manuals unless I absolutely have to. I still think it's a good idea, especially for more technical model building details, but I think if we intersperse tours/tips/hovers throughout the interface to answer most questions, more people will actually see it.

I messed around with reacttour and it was pretty easy to make a tour that could be shown to first time users. The code is quite compact, and easy to trigger actions including Router changes. It gets a bit trickier once the builder starts (arguable the most important part), but doable.

Just an idea, but here's some screenshots of what it looks like.

Screenshot from 2019-06-25 15-58-29

Screenshot from 2019-06-25 15-58-40

Screenshot from 2019-06-25 15-58-47

Screenshot from 2019-06-25 15-58-55

Screenshot from 2019-06-25 15-59-04

@codecov-io
Copy link

codecov-io commented Jun 25, 2019

Codecov Report

Merging #607 into master will increase coverage by 0.14%.
The diff coverage is 93.87%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #607      +/-   ##
==========================================
+ Coverage   72.39%   72.54%   +0.14%     
==========================================
  Files          53       55       +2     
  Lines        2054     2065      +11     
==========================================
+ Hits         1487     1498      +11     
  Misses        567      567
Impacted Files Coverage Δ
neuroscout/basic.py 100% <ø> (ø) ⬆️
neuroscout/utils/core.py 100% <ø> (ø) ⬆️
neuroscout/models/auth.py 95.83% <100%> (+0.18%) ⬆️
neuroscout/resources/analysis/reports.py 53.08% <100%> (-1.14%) ⬇️
neuroscout/resources/utils.py 95.91% <100%> (+0.17%) ⬆️
neuroscout/api_spec.py 100% <100%> (ø)
neuroscout/schemas/user.py 92.3% <100%> (+0.3%) ⬆️
neuroscout/utils/factory.py 100% <100%> (ø)
neuroscout/resources/predictor.py 97.56% <66.66%> (-2.44%) ⬇️
neuroscout/core.py 70.58% <86.66%> (-3.84%) ⬇️
... and 2 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b72343f...00b6f8d. Read the comment docs.

@tyarkoni
Copy link

That looks good to me. I think a manual is still important, but it's fine if it focuses more on the implementation details (i.e., stuff people need to know for their methods sections) than on the UI.

@adelavega
Copy link
Collaborator Author

Yep, agreed!

@adelavega adelavega added this to To Do (Frontend) in 0.9 via automation Jun 26, 2019
@adelavega adelavega moved this from To Do (Frontend) to In Progress in 0.9 Jun 26, 2019
@adelavega adelavega changed the title WIP: Neuroscout tour prototype Neuroscout tour prototype Jun 28, 2019
@adelavega adelavega changed the title Neuroscout tour prototype WIP: Neuroscout tour prototype Jun 28, 2019
@adelavega
Copy link
Collaborator Author

adelavega commented Jul 5, 2019

Okay, for this I added tooltips to all the pages

We still need to:

  • Implement tooltips only pop up on first time
  • Check text for all tooltips, maybe add some for every transformation
  • Decide if tour is necessary at all, or if we should take it further. I think it might be OK as is, if the pop ups follow the tour.

Also, this PR closes #605. For that wee need to:

  • Add back "predictions" question. When at the Run stage?
  • Remove FAQ link to manual

@adelavega adelavega changed the title WIP: Neuroscout tour prototype Neuroscout tour prototype Jul 5, 2019
@adelavega
Copy link
Collaborator Author

I'm going to go ahead and merge this, and we can keep working on it.

In particular, we need to add a place in the Transformations definition where we can put the tooltip text, and add that tooltip (with the idea each transformation would have its own tooltip helper).

We also need to add back the Predictions form (see #613)

@adelavega adelavega merged commit 7498ec2 into master Jul 8, 2019
0.9 automation moved this from In Progress to Done Jul 8, 2019
@adelavega adelavega changed the title Neuroscout tour prototype Neuroscout tour + tooltips in Builder Jul 8, 2019
@adelavega adelavega deleted the enh/tour branch October 2, 2019 22:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
0.9
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants