In-app help manual #628
Merged
In-app help manual #628
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
bnkai
reviewed
Jun 21, 2020
bnkai
reviewed
Jun 21, 2020
bnkai
reviewed
Jun 22, 2020
|
It looks ok to me. Maybe some more proofreading is needed but we might as well push it as it will be easier for the users to spot typos from the UI rather than reading through github. |
Tweeticoats
pushed a commit
to Tweeticoats/stash
that referenced
this pull request
Feb 1, 2021
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.
Resolves #619
Adds a help button next to the settings button:
Clicking this button opens a help dialog:
As seen in the screenshot above, there is a table of contents on the left. The table of contents collapses to above the content on smaller screens.
All of the content is presented via markdown files in the
docs/endirectory (no idea if localisation is worth doing).Links between help pages are done using
help/<filename>.mdand are handled by the manual control.I've taken the time to write a bunch of documentation and copy over some of the stuff that was in the wiki. A direct link to the markdown pages is here. I encourage as many people as possible to take a look at each of them to proof read them.