i79 - Add a help page and/or tooltips to the page

pacificclimate / weather-anomaly-tool

0 stars 0 forks source link

i79 - Add a help page and/or tooltips to the page #98

Closed rod-glover closed 2 months ago

rod-glover commented 3 months ago

Resolves #79

The initial commit adds a MD doc that can be used in part or in whole to form a Help page. Feedback on the following is welcome:

need
content
location (e.g., tab, pop-up, pop-out)

rod-glover commented 2 months ago

Now comes the question of how and where to integrate this information into the app. Putting the instructions on a separate tab is easy, but it means that the user can't refer to both the instructions and controls. Better would be slide-out(s) that leave the relevant part of the UI visible while displaying the relevant help. ClimateData.ca ver 2.0 of the Map component does this and it is effective.

rod-glover commented 2 months ago

Demo Thank you, John, for deploying it!

rod-glover commented 2 months ago

Reviewers: I've left the InfoPopup components (and supporting packages) in place, in case in future we decide that it would be helpful to use them too. At this point they are not used.

corviday commented 2 months ago

Formatting on the Help:Selectors tab has some wonkiness when displayed on my system. formatting3

formatting formatting2

Nospamas commented 2 months ago

Formatting on the Help:Selectors tab has some wonkiness when displayed on my system.

Formatting on the Help:Selectors tab has some wonkiness when displayed on my system.

These were caused by automatic formatting tools (which have now been disabled) on my machine when I did the deployment to the beehive. They should now be fixed @corviday.

For my part everything looks good on the demo. I'll go do a code review next :).