main
md 29 lines 975 Bytes
Rendered Raw
1 # Onboarding Plugin DOX
2
3 ## Purpose
4
5 - Own the built-in first-time onboarding wizard for model configuration.
6
7 ## Ownership
8
9 - `plugin.yaml` owns metadata and always-enabled status.
10 - `webui/` owns onboarding providers, wizard store, modal/page markup, and thumbnail.
11
12 ## Local Contracts
13
14 - Keep onboarding provider choices synchronized with model configuration and provider metadata.
15 - Do not ask for or expose API keys outside approved settings/API flows.
16 - Avoid blocking already-configured users with unnecessary onboarding prompts.
17 - Completion updates the selected global model preset (normally immutable-name `Default`); advanced setup opens that preset in the shared editor.
18
19 ## Work Guidance
20
21 - Coordinate provider changes with `_model_config` and `_oauth` when account-backed providers are involved.
22
23 ## Verification
24
25 - Smoke-test first-run onboarding, provider selection, completion, and skip/close behavior after changes.
26
27 ## Child DOX Index
28
29 No child DOX files.