diff options
| author | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-03-28 21:13:41 +0300 |
|---|---|---|
| committer | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-03-28 21:13:41 +0300 |
| commit | fa1adf1a26033fc50a2920d96045e76aba93bddb (patch) | |
| tree | 383bd48d0c6bcad7ccf1d5c907f78fd7eee1797f /CONFIGURATION.md | |
| parent | d05ba2ea9f1ab2379f5be5ef7fc3898a03f5dce1 (diff) | |
feat: add onboarding and toast notification preferences
Diffstat (limited to 'CONFIGURATION.md')
| -rw-r--r-- | CONFIGURATION.md | 35 |
1 files changed, 35 insertions, 0 deletions
diff --git a/CONFIGURATION.md b/CONFIGURATION.md index f78ec7ca..75cd0471 100644 --- a/CONFIGURATION.md +++ b/CONFIGURATION.md @@ -14,6 +14,21 @@ herdr --default-config if a config value is invalid, or two navigate actions use the same keybinding, herdr falls back to a safe default and shows a startup warning in the UI. +## onboarding + +```toml +onboarding = true +``` + +| option | default | description | +|--------|---------|-------------| +| `onboarding` | unset | show first-run notification setup; set `false` after choosing | + +notes: +- missing `onboarding` currently behaves like `true` +- set `onboarding = true` to force the setup screen again for testing +- after onboarding, herdr writes `onboarding = false` plus the chosen sound/toast settings + ## keybindings keybindings live under `[keys]`. @@ -83,6 +98,26 @@ accent = "cyan" - hex like `#89b4fa` - rgb like `rgb(137,180,250)` +## toast notifications + +```toml +[ui.toast] +enabled = false +``` + +### options + +| option | default | description | +|--------|---------|-------------| +| `ui.toast.enabled` | `false` | show top-right visual toasts for background agent events | + +current v1 behavior: +- informational only +- one toast at a time +- top-right placement +- shown for background agent events like `needs attention` and `finished` +- no keyboard action or temporary key semantics + ## sound ```toml |