Skip to content

Commit f9c9211

Browse files
Add doc update
1 parent ccf6686 commit f9c9211

1 file changed

Lines changed: 18 additions & 1 deletion

File tree

docs/faq.rst

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,29 @@ General
66

77
**Does the application require an internet connection?**
88

9-
No. The application is fully offline. It only reads and writes local files.
9+
No for normal clinical use: session recording, editing, and export work fully
10+
offline and only read and write local files. Optionally, the application can
11+
contact the public GitHub *releases* API (about once per day when enabled) to
12+
see whether a newer build is published; that request does not include patient
13+
or session content. If the network is unavailable or the check fails, the app
14+
continues without blocking. You can turn off automatic update checks from
15+
**Help** (or from the opt-out on an update notification).
1016

1117
**Is my patient data sent anywhere?**
1218

1319
No. All data stays on your local machine. No telemetry, no cloud sync.
1420

21+
**How does the automatic update checker work?**
22+
23+
When automatic checks are enabled, the app compares your installed version with
24+
published releases on the upstream GitHub repository (including pre-releases
25+
when they are the newest applicable tag), and notifies you if a strictly newer
26+
semver is available. Only one candidate release is considered—the highest
27+
version above yours. Update checks run in the background, do not block startup,
28+
and are skipped silently on errors. Use **Help** to toggle “Automatically check
29+
for updates”, or disable them from the checkbox on the update dialog if you do
30+
not want further automatic notifications.
31+
1532
**Which DBS systems are supported?**
1633

1734
The application is system-agnostic for data recording. Electrode visualisation

0 commit comments

Comments
 (0)