Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs-web/user/dashboard/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ The dashboard uses a **dock-based navigation** by default:
- **Sidebar** *(mobile or user preference)* — A collapsible left sidebar.
- **Top bar** — Project selector, techstack selector, theme toggle, mobile menu.

A choice of theme (Light / Dark / System) is in the top bar; navigation mode override is in **Settings → Appearance**.
A choice of theme (Light / Dark / System) is in the top bar; navigation mode override is in **Settings → Appearance**. During onboarding, Appearance choices preview immediately and the setup shell follows the selected Light, Dark, or System theme instead of forcing dark mode.

When a project is active, the top bar also shows its techstack. Projects imported before classification can remain unassigned; in that state the selector displays **None**. Choosing a stack from the dropdown saves only the project techstack selection.

The background is an animated Three.js scene ("Deep Ocean") that lazy-loads after the main UI is interactive, so it never blocks first paint.
The background is an animated Three.js scene ("Deep Ocean") that lazy-loads after the main UI is interactive, so it never blocks first paint. Onboarding can preview Background Mode and Static Color; advanced background controls such as Animation Style, Pattern Overlay, and custom background image remain in **Settings → Appearance**.

## Pages

Expand Down
8 changes: 4 additions & 4 deletions docs-web/user/dashboard/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The category rail on the left includes:
| **Memory** | Active embedding model selection. |
| **Agents** | Agent routing, markdown mirroring, persistent skill storage, storage attachments, and self-reflection criteria. |
| **Techstacks** | System catalog management, protected built-in stack, project stack assignment, and web/desktop application kind. |
| **Appearance** | Theme, navigation mode override, dashboard density. |
| **Appearance** | Theme, Navigation Mode, Reduced Motion, Background Mode, Static Color, and Zoom Level. |
| **Limits** | `maxFailures` emergency stop threshold and other safety caps. |

Each category opens one or more **content panels** with grouped fields. Inputs are typed (text, number with min/max, toggle, multi-select) and validate inline.
Expand Down Expand Up @@ -224,7 +224,7 @@ Related docs:

Reopens the guided setup flow without changing saved settings by itself.

**What it controls:** The action button launches onboarding so you can revisit provider, project, setup, and appearance prompts. Appearance choices preview immediately while onboarding is open, including theme, navigation mode, reduced motion, background mode, static color, and supported desktop zoom.
**What it controls:** The action button launches onboarding so you can revisit provider, project, setup, and Appearance prompts. Theme, Navigation Mode, Reduced Motion, Background Mode, Static Color, and supported Zoom Level choices preview immediately while onboarding is open, and the onboarding shell follows Light, Dark, or System instead of forcing dark mode.

**Recommended defaults:** Use it when setting up a new machine or after adding provider credentials.

Expand All @@ -241,7 +241,7 @@ Related docs:

Controls the dashboard shell layout, theme, motion preference, and desktop zoom when available.

**What it controls:** Navigation mode switches dock/sidebar, theme sets color mode, reduced motion limits animation, and zoom scales Electron windows.
**What it controls:** Navigation Mode switches dock/sidebar, Theme sets Light, Dark, or System color mode, Reduced Motion limits animation, and Zoom Level scales Electron windows.

**Recommended defaults:** Use System theme and Auto reduced motion unless you need a fixed accessibility preference.

Expand All @@ -258,7 +258,7 @@ Related docs:

Customizes the dashboard background image, animation mode, static color, and pattern overlay.

**What it controls:** Image upload, animated/static mode, animation style, color picker, and overlay pattern shape the visual layer behind panels.
**What it controls:** Background Image, Background Mode, Animation Style, Static Color, and Pattern Overlay shape the visual layer behind panels. Onboarding previews Background Mode and Static Color, while Animation Style, Pattern Overlay, and custom background image remain available here after onboarding.

**Recommended defaults:** Prefer lightweight images and readable contrast; use static mode if motion is distracting.

Expand Down
10 changes: 5 additions & 5 deletions docs/dashboard/onboarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The dashboard shows a first-run onboarding flow in the browser until the operato

The browser-local key `codeux:onboarding-complete:v1` is still written for compatibility, but onboarding visibility is owned by the persisted user-preferences state so refreshes and sign-in sessions do not reopen onboarding after complete or cancel.

The onboarding shell uses the same dashboard background and modal motion system as the Import and Add Project overlays. It derives its light or dark chrome from the current appearance draft and can switch between the animated background and the draft static color while onboarding remains open, so the Appearance step is previewed in place before final save. The shell is viewport-bounded, with the step body owning its own scrollbar for long provider configuration forms. Step entry, shortcut movement, progress feedback, selected provider/default choices, validation reveal, action feedback, and guided-tour highlight movement use the shared `enterExit`, `selectionMovement`, `inlineValidation`, `controlFeedback`, and `asyncFeedback` interaction contracts. Reduced-motion users receive static state changes, progress labels, visible outlines, and focus/selection states instead of animation-dependent cues.
The onboarding shell uses the same dashboard background and modal motion system as the Import and Add Project overlays. It follows the selected Light, Dark, or System theme instead of forcing dark mode, and it can switch between the animated background and the draft static color while onboarding remains open. Appearance choices publish the same unsaved appearance preview used by Settings, so the step is previewed in place before final save. The shell is viewport-bounded, with the step body owning its own scrollbar for long provider configuration forms. Step entry, shortcut movement, progress feedback, selected provider/default choices, validation reveal, action feedback, and guided-tour highlight movement use the shared `enterExit`, `selectionMovement`, `inlineValidation`, `controlFeedback`, and `asyncFeedback` interaction contracts. Reduced-motion users receive static state changes, progress labels, visible outlines, and focus/selection states instead of animation-dependent cues.

## Component Structure

Expand Down Expand Up @@ -111,9 +111,9 @@ The flow currently contains nine detailed steps, with the provider configuration
- Enables the QA agent for completion-time review workflows.
- Choice groups use typed settings values, keyboard-operable selection, and visible selected/success feedback.
9. Appearance
- Configures system defaults for theme, navigation mode, reduced motion, background mode, static background color, and desktop zoom when Electron zoom support is available.
- Previews Light, Dark, System, animated, and static background choices immediately in both the onboarding shell and the underlying dashboard background manager.
- Keeps advanced Settings-only controls such as animation style, pattern overlay, and custom background image out of onboarding.
- Configures system defaults for Theme, Navigation Mode, Reduced Motion, Background Mode, Static Color, and Zoom Level when Electron zoom support is available.
- Previews Theme, Reduced Motion, Navigation Mode, Background Mode, Static Color, and Zoom Level immediately in both the onboarding shell and the underlying dashboard background manager.
- Keeps advanced background controls such as Animation Style, Pattern Overlay, and custom background image in Settings -> Appearance after onboarding.

## Settings Persistence

Expand All @@ -127,7 +127,7 @@ Provider choices update:
- Legacy container auth-copy fields under `defaults.cliWorkflow` for compatibility
- Git onboarding mode under `defaults.cliWorkflow.gitMode`, which toggles the remote GitHub/GitLab setup cards and keeps git identity controls available in both modes

Appearance choices update the onboarding draft under `defaults.appearance`, which is also used by the Settings page. While onboarding is open, the draft appearance is published through the shared `codeux:appearance-preview` event so the root dashboard shell reapplies theme, reduced-motion, navigation, background mode, and static color without waiting for final save. The preview is cleared when onboarding closes, is canceled, completes, or unmounts. Final persistence still uses the same `PUT /api/system-settings` path as Settings. New installs start with sidebar navigation and the pattern overlay set to `None`.
Appearance choices update the onboarding draft under `defaults.appearance`, which is also used by the Settings page. While onboarding is open, the draft appearance is published through the shared `codeux:appearance-preview` event so the root dashboard shell reapplies Theme, Reduced Motion, Navigation Mode, Background Mode, Static Color, and Zoom Level without waiting for final save. The preview is cleared when onboarding closes, is canceled, completes, or unmounts. Final persistence still uses the same `PUT /api/system-settings` path as Settings. New installs start with sidebar navigation and the pattern overlay set to `None`.

Operators can reopen onboarding from `Settings -> General -> Onboarding`. The action resets the persisted onboarding completion state and clears the browser-local marker; it does not reset saved system or project settings.

Expand Down