orppst / pst-gui

web based front end for the tool
Mozilla Public License 2.0
0 stars 0 forks source link

Proof of concept contextual help stuff #204

Closed mwapst closed 1 month ago

mwapst commented 2 months ago

Presenting a Show/ Clear Help button on the more complex forms to tell the user what must be provided.

Republicof1 commented 2 months ago

The button position: -Ideally I would expect the button to be on the left hand panel (project level info). We are helping novice users - so it should be globally on or off in my view. -If there are additional requirements that I am not aware of precluding the above, the button should at the least be on the landing view for each tab. The current version of this expects users to press something before they see the help button.

The button element: -I'd suggest this could move to top right, inline with the proposal title make the button consistent in style with other buttons on the site use the "info" colour (assuming this theme has one).

Text - structure: -remove all leading CR where the "display-linebreak" class is used. -there may be too much information to say in this section. Perhaps we can look at other screen space placement to make it less intrusive to the flow . -it may also be valuable ensure that the help that is visible while you progress a task.

Text - content: -Text is fine for illustrative purposes but shouldn't be present the rest of the time.

SUGGESTED ACTION Consider the comments above for development keep the pull request open and we can look to co-develop this Consider some existing strategies such as tutorial plug-ins - e.g. https://introjs.com/ as an alternative flow

Republicof1 commented 2 months ago

I don't think I said what I mean to say in Text - content... it should read: -Text is fine for illustrative purposes, but should be improved before live deployment.