From df401b9e5529ed73e28c585f474ad9a83c592959 Mon Sep 17 00:00:00 2001 From: Beda Schmid Date: Sat, 21 Feb 2026 12:29:53 -0300 Subject: [PATCH] Improve settings hints and workspace log clarity --- doc/README.md | 2 +- doc/frontend-design-foundation.md | 7 +++ frontend/src/components/SettingsScreen.tsx | 54 ++++++++++++++++++++-- frontend/src/styles.css | 35 ++++++++++++++ 4 files changed, 92 insertions(+), 6 deletions(-) diff --git a/doc/README.md b/doc/README.md index 3521b19..8fcf45b 100644 --- a/doc/README.md +++ b/doc/README.md @@ -9,4 +9,4 @@ This directory contains technical documentation for DMS. - `api-contract.md` - API endpoint contract grouped by route module, including settings and processing-log trim defaults - `data-model-reference.md` - database entity definitions and lifecycle states - `operations-and-configuration.md` - runtime operations, ports, volumes, and persisted settings configuration -- `frontend-design-foundation.md` - frontend visual system, tokens, and UI implementation rules +- `frontend-design-foundation.md` - frontend visual system, tokens, UI implementation rules, and settings helper-copy guidance diff --git a/doc/frontend-design-foundation.md b/doc/frontend-design-foundation.md index 0ccf488..ca52093 100644 --- a/doc/frontend-design-foundation.md +++ b/doc/frontend-design-foundation.md @@ -50,3 +50,10 @@ When adding or redesigning a UI area: 3. Implement component styles in `frontend/src/styles.css` using existing layout and variant conventions. 4. Validate responsive behavior at `1240px`, `1040px`, `760px`, and `560px` breakpoints. 5. Verify keyboard focus visibility and text contrast before merging. + +## Settings UX Copy + +- Keep helper copy in settings short and plain language, especially on advanced model and threshold controls. +- Prefer one concise hint per advanced control that explains practical impact rather than internals. +- In the Workspace settings block, keep processing-log controls visually separated from default path and tag behavior. +- Processing-log hints must explicitly state they affect logs and retention behavior, not document metadata values. diff --git a/frontend/src/components/SettingsScreen.tsx b/frontend/src/components/SettingsScreen.tsx index 5b27bcd..fe52135 100644 --- a/frontend/src/components/SettingsScreen.tsx +++ b/frontend/src/components/SettingsScreen.tsx @@ -1,5 +1,6 @@ /** * Dedicated settings screen for providers, task model bindings, and catalog controls. + * Uses concise helper hints for advanced runtime and provider settings. */ import { useCallback, useEffect, useMemo, useState } from 'react'; import type { JSX } from 'react'; @@ -67,7 +68,7 @@ function clampProcessingLogUnboundEntries(value: number): number { } /** - * Renders compact human-oriented settings controls. + * Renders compact human-oriented settings controls with plain-language hints. */ export default function SettingsScreen({ settings, @@ -367,6 +368,7 @@ export default function SettingsScreen({ onChange={(nextPath) => setUploadDefaults({ ...uploadDefaults, logical_path: nextPath })} suggestions={knownPaths} /> + Used when you upload without choosing a path. +
+

Processing Log Controls

+

+ These settings affect processing logs only. They do not change default path, tags, or document cards. +

+
-