@synap-core/onboarding-core
v0.1.0
Published
Universal onboarding contracts: session types, primary goals, prompt frame helpers, analytics event names (no UI)
Readme
@synap-core/onboarding-core
Purpose: Shared, UI-free contracts for universal onboarding across Relay, Browser, content apps, the Data Pod, and the Intelligence Service.
Contents
- Types:
OnboardingSessionState,PrimaryGoalId,OnboardingAppSurface, defaults (defaultPrimaryGoalForApp: Relay → feed, Browser → bento, Content → project). - Analytics: Stable event name constants (
OnboardingAnalyticsEvents) for funnel instrumentation. - Prompt frame:
buildMainOnboardingSystemPrompt()— parameterized system prompt for IS (anti-extrapolation, clarify, memory).
Usage
- Clients: Import types + analytics constants; emit events at session start/complete.
- IS: Import
buildMainOnboardingSystemPrompt+ app-specific secondary objective text fromsynap-intelligence-service/.../universal-onboarding/app-profiles. - Pod (future): Persist
OnboardingSessionStatevia tRPC when APIs land (see team ADR).
Related
@synap-core/onboarding— React onboarding UI (dialogs, steps). Add@synap-core/onboarding-coreas a workspace dependency to apps that need shared types; runpnpm installat the monorepo root to refresh the lockfile after adding.Team docs: Universal onboarding north star, S-tier Definition of Done, ADR onboarding session & memory.
