tokio-rs
Introduce new help view to display information on any view
As a part of addressing #225 , I'm introducing a new floating pane which can show information relevant to the current in focus pane. This can include shortcuts, key bindings and glossary information when using symbols and emojis..
Does anyone have thoughts on what the contents of the help popup should be in different views? For now I'm working on the mechanism to pump the information from the view to the popup. This is what it looks like currently:
@bIgBV this is awesome, thanks for working on this!
As for what should be displayed in the help text:
- I think we should probably display the controls for the current view, even though they're also displayed in the header...perhaps once the help text feature is merged, we should consider hiding the controls from the header by default, and just display what key is needed to open the help text?
- It could be useful to explain the meanings of different emojis/symbols in the current view?
- Eventually, the same popup system could maybe be used for displaying detailed descriptions of warnings, but that's something we would add later (since we don't have a system for associating help with warnings yet...)
- I think including the controls and what the symbols mean in a given page in the popup would be a good start.
- And I love the idea of displaying the meaning behind/expanding on warnings in the future. And it should be fairly straightforward to extend this to perform that function.
@hawkw got the text in the help popup to wrap properly (thanks again for the suggestion).
I also updated the text in the detail views to be (slightly) less generic. I think this is in a good place to be merged and I could separately open a new PR once we finalize the content of the help text for different views.
@bIgBV sorry it took me so long to look at this, I'd really like to actually give it a review now. It looks like this branch is now out of date with main, can I get you to rebase or merge main?
@hawkw I completely missed my notifications on this. While I'm still interested in working on this, my job has kept me pretty busy, and will keep doing so for the next couple of weeks. So if you can pull in my changes and add the ones you suggested on top of that, please go for it!
@bIgBV Hey, would you feel comfortable giving me write access to your fork repo ("Adding contributors" in settings). Otherwise, I'd need to start a fork from scratch and apply your changes etc. which might get a bit gnarly, and we'd lose this convo history.
As no further progress had been made on this PR, a new one was opened (#432) inspired by it and has now been merged.
