A usage guide in the menu bar, and an interface page that explains the interface - #192
Merged
Conversation
The UI page listed the tabs and stopped there. Someone reading it still did not know what an overlay is, that clicks pass through one, what opacity or target monitor do on every page, or how to get everything off the screen again. It now says all of that first and lists the tabs last, grouped by what you would be trying to do. Help now opens with How to use..., a short guide in the application itself covering the same ground: the first overlay in three steps, the settings every page shares, that overlays do not take your clicks, the Control Center, and F12. Someone who has just installed this should not have to find the website to learn what it does. The last button goes to the full documentation for the rest. Sixteen strings in each of the seven languages, and the guide follows a language change while it is open - headings and bodies, not just the title.
|
Up to standards ✅🟢 Issues
|
| Metric | Results |
|---|---|
| Complexity | 4 |
| Duplication | 0 |
NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Two things: the UI documentation page was thin, and there was nowhere in the application itself that said how to use it.
The UI page now explains rather than lists
It used to be a bullet list of tab names. Reading it, you still would not know:
All of that comes first now, with the tabs at the end grouped by what you are trying to do — put something on screen, work more comfortably, show your screen to other people — rather than one flat list. Rewritten in all seven languages.
Help → How to use...
A short guide inside the application, first item in the Help menu. Someone who has just installed this should not have to find the website to learn what it does.
Six sections: your first overlay in three steps, the settings every page shares, overlays do not take your clicks, managing several at once, clearing the screen (including F12), and keeping what you set up. A Full documentation button goes to readthedocs for the rest.
Deliberately a quick start, not a second copy of the manual — two copies of the same prose drift apart, and the manual is one click away.
Details
menus.rstin all seven languages.**bold**runs straight into the next character with no space, and docutils will not close the markup —\joins them.Tests
Two added to
test_live_language_switch.py: the guide opens from the Help menu with every section rendered, and after switching to German no section is left in English. Mutation-checked — dropping the menu entry, or building the headings or bodies without registering them, each fails the suite.883 passed, pyflakes silent.