aboutsummaryrefslogtreecommitdiffstats
path: root/desktop/modules
diff options
context:
space:
mode:
Diffstat (limited to 'desktop/modules')
-rw-r--r--desktop/modules/notifications/README.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/desktop/modules/notifications/README.md b/desktop/modules/notifications/README.md
new file mode 100644
index 0000000..c3b2e9d
--- /dev/null
+++ b/desktop/modules/notifications/README.md
@@ -0,0 +1,18 @@
+# notifications (settings page)
+
+Edits `~/.config/notifyd/config.json`, the one file behind both the daemon
+and the balloon shell:
+
+| key | read by |
+| --- | --- |
+| `timeouts`, `liveCap`, `historyCap` | notifyd, at start and on `notifyctl reload` |
+| `balloons`, `dndPassCritical`, `muted` | both shells, through `Notify.config` |
+
+`shared/NotifyConfig.js` resolves the file over its defaults and holds the
+mute/DND decision. Check: `node shared/test_notify_config.js`.
+
+Save writes the file with `cat` (unknown keys kept) then runs `notifyctl
+reload`. If notifyd is not running the file is still written and the page
+says so; the daemon reads it when it starts.
+
+Snooze is not here: the status tile has it.