Skip to content

Desktop: Getting started wizard after the first sign-in (#422) - #446

Merged
Sebagrei merged 3 commits into
mainfrom
feature/422-desktop-first-start-wizard
Nov 22, 2026
Merged

Sebagrei merged 3 commits into
mainfrom
feature/422-desktop-first-start-wizard

Conversation

@Sebagrei

@Sebagrei Sebagrei commented Nov 22, 2026 •

Copy link
Copy Markdown
Collaborator

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):

  1. Server: skipped when a policy fixes the server (Desktop: managed deployment policies (server URL, updates, crash reports) #378).
  2. Sign-in: always done by the time the wizard opens, so it shows as a ticked step.
  3. Working folder: what it is and the path, with Change… (folder picker, then the existing set_workspace_dir command) and Open folder.
  4. Project group: your groups and Get project groups… (the existing dialog: latest revision, also in work). Skipped when you are in no group, or when a finished Get on this computer already fetched all of them into this working folder. group-sync.js remembers that in localStorage, per working folder. This is only a convenience, and the wizard falls back to showing the step.
  5. CAD setup: information only. It lists the Inventor .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.
  6. Daily loop: Check out and open → save in CAD → Check in…, plus Finish and open (makes one of your groups active, a fetched one first, and shows its files in Home – right-click the assembly → Check out and open; Finish and show Projects only without a group) and Finish and open my worklist.

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 new onboarding: Option<String> field with a serde default, so older settings files still load. Also onboarding_value() (accepts only done or dismissed) and three tests.
  • commands.rs: Session.onboarding and the new command set_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.mjs covers when the wizard shows, the skip rules, next/back, positions and texts. It is registered in the ui job of desktop.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 --check in desktop/. CI runs the desktop build, clippy, the Rust tests, node --check, check-desktop-modules.mjs and the new Node test. The dialog itself still needs a manual check in the app.

Checklist

  • This is my own work (or my AI agent's, written from its own
    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).
  • Reading a file format: not applicable (no format work).
  • The documentation is updated in this pull request (CHANGELOG.md,
    README.md, docs/src/**, docs/OPEN_WORK.md where it applies).
  • cargo fmt --all --check, cargo clippy --all-targets -- -D warnings
    and cargo test pass locally, or CI runs them. (Only fmt ran locally; CI runs the rest.)

🤖 Generated with Claude Code

fork and others added 2 commits November 22, 2026 19:45
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
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
@Sebagrei
Sebagrei merged commit ef647ce into main Nov 22, 2026
5 checks passed
@Sebagrei
Sebagrei deleted the feature/422-desktop-first-start-wizard branch November 22, 2026 20:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant