docs: add product screenshots to public guides (#3126)
This commit is contained in:
@@ -29,7 +29,7 @@ See [Desktop app](desktop-app.md), [CLI](cli.md), [Run as a service](run-as-a-se
|
||||
|
||||
## Prevent host sleep during active tasks
|
||||
|
||||
Administrators can open **Settings > General > Task Actions** and enable
|
||||
Administrators can open **Settings > Preferences > Task Behavior** and enable
|
||||
**Prevent host sleep while tasks run**. The install-wide setting is off by
|
||||
default and is saved with the Kandev database. It applies only to the machine
|
||||
running the backend; it does not change executor or node power policy.
|
||||
@@ -56,6 +56,8 @@ availability policy instead. Enabling the preference is safe when moving the
|
||||
database between hosts: Kandev reacquires a native request only after startup
|
||||
if the new backend can provide it and a working task still exists.
|
||||
|
||||

|
||||
|
||||
## Health and readiness
|
||||
|
||||
Use the top-level liveness endpoint for process supervisors:
|
||||
@@ -86,6 +88,8 @@ curl -fsS http://127.0.0.1:38429/api/v1/system/health
|
||||
|
||||
This diagnostic checks the Git executable, GitHub authentication/rate limits, agent discovery, and Linux inotify pressure. It returns a JSON `healthy` field and issue list, but normally uses HTTP 200 even when `healthy` is false; do not substitute it for `/health` in a status-only probe.
|
||||
|
||||

|
||||
|
||||
For a managed service, also check its process manager:
|
||||
|
||||
```bash
|
||||
@@ -133,12 +137,15 @@ The System Database and Backups pages use the configured SQLite file path. They
|
||||
<details>
|
||||
<summary>Storage maintenance details</summary>
|
||||
|
||||
Open **Settings > System > Storage** to inspect Kandev-managed disk usage and configure cleanup.
|
||||
Open **Settings > System > Data & Logs**, then use the **Storage** section to
|
||||
inspect Kandev-managed disk usage and configure cleanup.
|
||||
**Analyze** is read-only. **Run now** applies only the enabled cleanup rules and refuses to start
|
||||
while another maintenance run owns the cleanup gate. If task resources are active, the page names
|
||||
the active work and offers **Run anyway** after an explicit disruption warning. Use that override
|
||||
only when the active task work can tolerate cleanup running alongside it.
|
||||
|
||||

|
||||
|
||||
Storage analysis results are cached in the running backend for 15 minutes, so page reloads and
|
||||
policy saves reuse the displayed snapshot instead of scanning disk again. The page shows when that
|
||||
snapshot was last analyzed. Select **Analyze** to force a fresh scan; restarting the backend also
|
||||
@@ -156,6 +163,8 @@ permanent deletion. Each entry shows its `delete_after` retention deadline: **De
|
||||
time, not an exact promise, the first successful scheduled or full manual maintenance run after the
|
||||
deadline performs the purge, subject to the idle gate and any preemption.
|
||||
|
||||

|
||||
|
||||
Use **Clear eligible** to remove only entries whose deadlines have passed. It reports protected
|
||||
entries that remain. **Force clear all** requires typing `DELETE ALL NOW` and attempts to permanently
|
||||
remove every active quarantine entry, discarding restore windows for entries that are successfully
|
||||
@@ -163,6 +172,8 @@ deleted. Safety-validation or deletion failures may leave entries visible and re
|
||||
override bypasses only the retention timestamp; path, ownership, state, and filesystem safety
|
||||
checks still apply.
|
||||
|
||||

|
||||
|
||||
Kandev keeps at most one restorable Go-cache generation for each original cache path. If that
|
||||
generation is still active when the replacement cache exceeds its limit, the next rotation is
|
||||
deferred. The maintenance run succeeds and reports `active_quarantine`; both the live cache and
|
||||
@@ -194,6 +205,8 @@ Host-wide Docker build-cache and unused-image cleanup remain disabled until you
|
||||
owns a dedicated Docker daemon.
|
||||
Do not enable those rules on a daemon shared with unrelated workloads.
|
||||
|
||||

|
||||
|
||||
The Storage page also reports **Kandev temporary artifacts** created by services that need a
|
||||
short-lived directory under the host temporary root. Each current artifact is registered in the
|
||||
Kandev database and carries an owner-only marker in its exact directory. Active artifacts and
|
||||
@@ -469,6 +482,8 @@ Collection starts only while at least one connected client displays metrics in t
|
||||
|
||||
These metrics are lightweight UI observability. Set alerts, retention, CPU/memory limits, and disk quotas in the host, container platform, or external monitoring stack.
|
||||
|
||||

|
||||
|
||||
## Status bar visibility
|
||||
|
||||
The status surface is off by default for each user. Open **Settings > Preferences > Appearance > Status Bar**, enable **Show status bar**, and use the page's shared **Save changes** action. The portable preference applies immediately without restarting Kandev. It shows a 24 px bottom bar on desktop and fine-pointer tablets; phones use native Status controls and an inset Status drawer.
|
||||
|
||||
Reference in New Issue
Block a user