Context sensitive help #3563
Merged
Context sensitive help #3563
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
HebaruSan
added
Enhancement
techman83
approved these changes
Aug 3, 2022
There was a problem hiding this comment.
My only comment would be here, that we might want to centralise these URLs as constants somewhere. Digging through the code base if we had a to change a bunch of URLs would make for a maintenance burden (though I appreciate we probably already have this burden.)
|
Good idea, moved them to a new ... and moved |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation
We had somebody stop by the Discord asking how to use the Manage Game Instances popup, which appears by itself, blank, if you have no game instances and CKAN can't find one in Steam.
We added some help menu options in #3437, but these not accessible from the Manage Game Instances popup. (And that pull request's changes have not been released yet.)
Changes
.HelpButtonistruefor most of our popup dialogs.MinimizeBoxand.MaximizeBoxarefalsefor Manage Game Instances and Install Filters, which they probably should have been anyway because maximizing and minimizing these popups is not usefulOnHelpButtonClickedandOnHelpRequestedto open the most relevant help page for each context (the user guide by default, more specific links such as PRs when available)Now to access help, users will be able to press F1 anywhere or click this question mark button for most of our popups:
(Note that this button is not added to the main form because it is mutually exclusive with the minimize and maximize buttons, which we should keep for the main form.)
This should allow some users to find help on their own, and it will simplify many support requests down to telling users, "You can press F1 for help on that".