main
md 37 lines 1.99 KB
Rendered Raw
1 # Welcome Components DOX
2
3 ## Purpose
4
5 - Own the WebUI welcome screen, discovery cards, banners, and related state.
6
7 ## Ownership
8
9 - `welcome-screen.html` owns welcome screen markup and layout.
10 - `welcome-store.js` owns welcome state, banners, cards, and actions.
11
12 ## Local Contracts
13
14 - Keep banner and discovery card behavior compatible with Python `banners` extensions.
15 - Supported banner/card CTA actions must stay synchronized with plugin discovery contracts.
16 - Banner body links may use `data-banner-action`; these actions route through the same welcome action dispatcher as CTA buttons.
17 - `open-modal:` banner actions may include a `#section-id` fragment, which updates the page hash before opening the modal so settings sections can deep-link correctly.
18 - Do not show setup prompts for already configured plugins when backend status can prevent it.
19 - Do not replace the welcome composer with blocking model setup UI; missing model setup is deferred to the chat thread on first send.
20 - The welcome screen mounts the shared chat composer to start a new chat; keep it mutually exclusive with the normal chat input DOM.
21 - Keep the welcome container background transparent so the persistent right-panel background transition remains visible when entering and leaving Welcome.
22 - Reserve the welcome composer's final minimum height before its nested input components hydrate.
23 - Render `system-resources` as the dedicated System Resources panel, not as a generic alert banner.
24 - Utility quick actions from welcome must keep the first screen intact; use modal/floating entry points instead of docking the right canvas beside welcome content.
25
26 ## Work Guidance
27
28 - Coordinate visual card or CTA changes with plugin discovery and onboarding surfaces.
29 - Keep the lower welcome grid focused on Connect Channels, OAuth accounts, and System Resources unless the target design changes.
30
31 ## Verification
32
33 - Smoke-test alert banners, feature cards, dismissal, priority ordering, and CTA actions after changes.
34
35 ## Child DOX Index
36
37 No child DOX files.