Repository navigation
feat(yasgui): "How MatGUI works" quick start tour - #249
Merged
Merged
Conversation
The help button opens a small menu with the documentation and any entries added with yasgui.helpMenu.addItem() (quick start, what's new). With one entry the button runs it directly, so the default stays one click.
Five pages with three items each, a small illustration and a short explanation. Opens on the first visit (remembered in local storage), stays available from the help menu and the Ctrl+K search, and links to the user guide. Embedders can set showQuickStart: false, or quickStartOnFirstVisit: false to only offer it in the help menu.
3 tasks done
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
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.
Requested by Mathias · project thread
What
A first-run modal, How MatGUI works: five pages, three items each with a small schematic illustration and a short explanation.
ai.enabledis false)matgui_quickStart_seen, versioned so a future tour can be shown again).helpUrl); Next/Back, dots, ←/→ keys, Esc, Skip / Start querying. Focus is kept inside the dialog.showQuickStart: falseleaves it out,quickStartOnFirstVisit: falseonly offers it in the help menu.Help menu
This PR includes the help menu commit from the "What's new" work (
HelpMenu.ts, branchclaude/project-thread-hcxg0w) unchanged, so whichever PR merges first, the other rebases cleanly. The tour registers itself withhelpMenu.addItem({ id: "quickStart", order: 10 }).Tests and docs
test/quick-start-browser.ts(6 tests: first visit, navigation, guide link, no reopen + help menu, both options).getPage()marks the tour as seen unless a test asks for it, so the other browser tests are unaffected. Full puppeteer suite passes locally.@matdata/yasgui.Generated by Claude Code