Expand description
Onboarding tutorial — multi-step walkthrough of the TUI.
Triggered automatically on first launch (sentinel file at
.team/state/ui-tutorial-completed — separate from PR-UI-1’s
~/.config/teamctl/ui-tutorial-completed, which marks
per-machine completion; the per-team sentinel lets a brand-new
checkout teach a returning operator about its specific shape
without re-prompting machine-wide).
Reopenable from any non-modal state via the t chord — the
statusline’s always-visible · t tutorial hint is the
discovery surface. Skippable via Esc or first key per SPEC.
Structs§
Constants§
Functions§
- has_
completed - mark_
completed - Mark this team’s tutorial as completed by creating the
sentinel file. The design intent is presence-based: only
the file’s existence matters, never its contents — a partial
write that leaves an empty / truncated file still satisfies
has_completed. That’s accidentally robust to crash-during- write (the auto-trigger correctly fires once, then any later completion makes it stop firing forever) but the property is load-bearing, not coincidental:has_completeddeliberately does NOT validate file content. Future readers tempted to add atomic-rename or content-validation should know that the existing crash-safety story already lives entirely in the presence check; tightening write semantics doesn’t strengthen the contract, it just adds surface area. - sentinel_
path - Per-team sentinel file path. Returns
Nonewhen no team root is reachable — onboarding is then a noop and the tutorial auto-trigger doesn’t fire.