docs: correct the user manual, and name the two menus for users - #650
Merged
Conversation
Started from one wrong sentence and checked the rest. Five corrections, four of them things this session's UI work invalidated. USERMANUAL "the active page is underlined in the accent colour" -- it never was. Both nav levels mark the active item with accent colour + weight and no underline; that was an explicit call in the Zune redesign, and the pivots use the same cue deliberately. The tablet switcher was described as "at the top-right ... shown when more than one is connected". It now sits in the top navigation bar (it moved there this session), and it is NOT gated on tablet count -- ShowTabletSwitcher is just "are we on Tablet or Pen". Checked for a count gate before rewriting; there is none anywhere. Home tablets were described as having "a Settings button and a Forget button". The per-row Settings button was replaced by double-click, and Forget is a trash icon. HOME.md already said this correctly, so the two pages disagreed. TABLET / PEN Both described a per-page header holding the switcher + Refresh. There is no page header any more; both live in the top navigation bar. SETTINGS The theme list named four skins. There are six -- Dark Sakura and Custom were missing. Pre-existing, not from this session. Also verified as still ACCURATE and left alone: HOME's double-click and trash description, and ADVANCED's claim that the Diagnostics "Show" picker is hidden with a single tablet (ShowTabletPicker really is Count > 1). Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
… & opacity Terminology, in the user-facing docs only. The mental model is that the app is made of PAGES, and a page may be divided into TABS -- so the two menus are named after what they select: page menu the top row (was "top navigation bar") tab menu the row beneath it (was "pivot row") Pages with nothing to divide (Home, Scribble) simply have no tab menu, which the manual now says outright rather than leaving to inference. The internal names are untouched: WordmarkNav / PivotTab in the code and "wordmark bar" / "pivots" in the redesign spec still mean what they always did. This is what we call them TO USERS, not a rename of the implementation. Also fills the documentation gap under Appearance. Highlight colour and Card colour existed but had never been written up -- only Card opacity had. The new "Colours & opacity" section covers all four controls, how the picker works (swatch + hex, opening a wheel / palette / hex box), that everything is stored PER SKIN, and what Reset to defaults actually resets. And one more inaccuracy found while verifying that section against the source: "Falling petals (Sakura only)" is wrong -- ShowPetalsToggle is Sakura OR Dark Sakura OR Custom. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
TheSevenPens
changed the title
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.
Started from one wrong sentence, checked the rest of the manual, then renamed the two menus for users and filled a documentation gap.
Terminology (second commit)
The mental model is that the app is made of pages, and a page may be divided into tabs. So the two menus are named after what they select:
Pages with nothing to divide (Home, Scribble) simply have no tab menu — the manual now says that outright rather than leaving it to inference.
Internal names are untouched.
WordmarkNav/PivotTabin the code, and "wordmark bar" / "pivots" in the redesign spec, still mean what they always did. This is what we call them to users, not a rename of the implementation.Corrections (first commit)
ShowTabletSwitcheris simply "are we on Tablet or Pen".HOME.mdalready said this correctly, so the two pages contradicted each other.Dark SakuraandCustomwere missing.Documentation gap filled
Highlight colour and Card colour existed but had never been written up — only Card opacity had. The new Colours & opacity section covers all four controls, how the picker works (swatch + hex, opening a wheel / palette / hex box), that everything is stored per skin, and what Reset to defaults actually resets.
Verifying that section against the source turned up one more error: "Falling petals (Sakura only)" is wrong —
ShowPetalsToggleis Sakura or Dark Sakura or Custom.Checked and left alone
HOME.md'"'"'s double-click + trash description — already correct.ADVANCED.md'"'"'s claim that the Diagnostics Show picker hides with a single tablet — verified,ShowTabletPickerreally isCount > 1.Docs only, no code. Every claim was checked against the source rather than against memory of what we built.