Repository navigation
Desktop: Getting started wizard after the first sign-in (#422) - #446
Merged
Merged
Conversation
A short wizard opens after the first sign-in and from Help -> Getting Started...: server (skipped when a policy fixes it), sign-in, working folder (Change..., Open folder), Get project groups... (skipped without groups or when a finished Get already fetched them into this working folder), the CAD setup for information only (nothing is created) and the daily loop Check out and open -> save in CAD -> Check in.... Every step has Skip, Back, Next and Don't show again. Finish or Don't show again is stored as `onboarding` in settings.json (serde default, so older settings files still load) through the new set_onboarding command. An app that starts already signed in does not open it by itself. Step rules in desktop/ui/js/onboarding-rules.js (pure), tested by scripts/desktop-onboarding-rules.test.mjs in the desktop ui job. The wizard creates no file or folder itself. Creating the .ipj, NX load options and Solid Edge search paths stays open in OPEN_WORK section 4 (needs the CAD programs to verify). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- The last step offers *Finish and open <group>*: it makes one of the user's groups active (a fetched one first, startGroup in onboarding-rules.js) and shows its files in Home; the step text names the next action (right-click the assembly -> Check out and open). *Finish and show Projects* only without a group. - Get project groups remembers the groups for the wizard only after a complete run: not stopped, no failed item or name clash, rule *Latest revision*. - The step list marks steps passed with *Skip* as skipped, not done, and speaks the status through a visually hidden text. - Docs: the buttons per step as they are (*Back*, *Skip*, *Next*, and *Finish* on the last step); OPEN_WORK notes #422 stays open for the CAD file creation (step 5). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Sebagrei
marked this pull request as ready for review
November 22, 2026 20:50
…irst-start-wizard # Conflicts: # .github/workflows/desktop.yml # CHANGELOG.md # desktop/ui/js/main.js # docs/OPEN_WORK.md # docs/src/guide/desktop.md # docs/src/guide/getting-started.md
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.
Part of #422 – the issue stays open for its step 5 (creating the Inventor
.ipj, NX load options and Solid Edge search paths), tracked in OPEN_WORK §4.What changed
A first-start wizard Getting started in the desktop app. It opens after the first sign-in, and Help → Getting Started… opens it again.
Steps (logic in the pure module
desktop/ui/js/onboarding-rules.js):set_workspace_dircommand) and Open folder.group-sync.jsremembers that in localStorage, per working folder. This is only a convenience, and the wizard falls back to showing the step..ipj, NX load options and Solid Edge search paths that a later version will offer, and writes nothing. Generating these files stays open in OPEN_WORK §4, because nobody can verify the output without the CAD programs.Every step has Don't show again; Back, Skip and Next move between the steps, and the last step has Finish. Steps passed with Skip are marked skipped (also as hidden text for screen readers). The wizard creates no file or folder itself. It only opens the app's own actions, and those still need the user to confirm.
The Rust changes are small:
settings.rs: a newonboarding: Option<String>field with a serde default, so older settings files still load. Alsoonboarding_value()(accepts onlydoneordismissed) and three tests.commands.rs:Session.onboardingand the new commandset_onboarding.main.rs: the Help → Getting Started… menu item and the command registration.An app that starts already signed in, such as an update from an older version or a window reload, does not open the wizard by itself. Help still opens it.
Tests:
scripts/desktop-onboarding-rules.test.mjscovers when the wizard shows, the skip rules, next/back, positions and texts. It is registered in theuijob ofdesktop.yml.Docs:
CHANGELOG.md,README.md,desktop/README.md,docs/src/guide/desktop.md(new section Getting started),docs/src/guide/getting-started.md,docs/OPEN_WORK.md(the #408 entry, Workspace setup wizard, Interactive onboarding).How it was tested
Not compiled or run locally. This machine has no builds, and Node.js is not installed here either, so the Node test and the module check have not run yet. I only ran
cargo fmt --all --checkindesktop/. CI runs the desktop build, clippy, the Rust tests,node --check,check-desktop-modules.mjsand the new Node test. The dialog itself still needs a manual check in the app.Checklist
knowledge), or openly licensed material under a compatible licence
that is credited. It contains no code decompiled, disassembled or
rewritten from proprietary software and no leaked code
(CONTRIBUTING.md).
CHANGELOG.md,README.md,docs/src/**,docs/OPEN_WORK.mdwhere it applies).cargo fmt --all --check,cargo clippy --all-targets -- -D warningsand
cargo testpass locally, or CI runs them. (Only fmt ran locally; CI runs the rest.)🤖 Generated with Claude Code