Skip to main content

Module tutorial

Module tutorial 

Source
Expand description

First-launch detection via a marker file under the user’s config directory. PR-UI-1 ships only the plumbing: is_completed() reads the marker; the actual onboarding tutorial that writes the marker lands in PR-UI-7.

Functions§

is_completed
Has the operator finished the onboarding tutorial on this machine? Returns false when the marker is absent, the config dir is unresolvable, or the file is unreadable for any reason — first-launch detection should never panic an otherwise-healthy launch.
mark_completed
Write the marker so subsequent launches skip the tutorial. Reserved for PR-UI-7’s tutorial completion path; here only as the boundary of the public API so the rest of the crate can refer to it.
marker_path
Returns the path the marker file lives at. Honours XDG_CONFIG_HOME via dirs::config_dir, falling back to platform defaults.