From d79366d495111f1f9e586f1ffd1ed4b6570a952f Mon Sep 17 00:00:00 2001 From: Saagar Date: Sat, 4 Jul 2026 04:34:29 -0700 Subject: [PATCH] docs: tune UI review guidance --- AGENTS.md | 5 +++++ src/AGENTS.md | 18 ++++++++++++++++++ tests/ui/AGENTS.md | 12 ++++++++++++ 3 files changed, 35 insertions(+) create mode 100644 src/AGENTS.md create mode 100644 tests/ui/AGENTS.md diff --git a/AGENTS.md b/AGENTS.md index ef40cb3..ea0f829 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -33,6 +33,11 @@ explicit design change as merge-relevant. For UI PRs, comment when the diff lacks verification for the changed surface or would make an important workflow inaccessible, visually clipped, or misleading. +Review UI changes against the real support workflow: knowledge search, +grounding/reranking, draft generation, source review, settings, ingest, and +workspace selection. Loading, empty, permission-denied, offline/local-model +unavailable, search-no-results, and backend-error states are merge-relevant +when the changed surface can leave the operator stuck or misled. For docs-only PRs, comment only when docs claim current privacy, encryption, model-routing, release, performance, or verification behavior that the reviewed files or commands do not support. diff --git a/src/AGENTS.md b/src/AGENTS.md new file mode 100644 index 0000000..a57e4f3 --- /dev/null +++ b/src/AGENTS.md @@ -0,0 +1,18 @@ +# AGENTS.md - AssistSupport Frontend + +## Review guidelines + +Treat React UI changes as support-operator workflow changes. Review for +keyboard access, focus management, screen-reader labels, responsive behavior, +loading/empty/error states, and whether the UI clearly distinguishes local +processing from any future cloud-backed path. + +For knowledge search, draft, source review, ingest, settings, workspace, and +local-model surfaces, stale or ambiguous status is merge-relevant. The UI must +not imply that a draft is grounded, encrypted, synced, indexed, or locally +generated unless the state is actually true. + +Visual review should cover the changed breakpoint and the changed state. If a +component changes layout, navigation, forms, modals, tables, or result cards, +look for clipping, overlapping controls, lost focus, non-obvious disabled +states, and inaccessible icon-only controls. diff --git a/tests/ui/AGENTS.md b/tests/ui/AGENTS.md new file mode 100644 index 0000000..3783f4e --- /dev/null +++ b/tests/ui/AGENTS.md @@ -0,0 +1,12 @@ +# AGENTS.md - AssistSupport UI Tests + +## Review guidelines + +Treat UI tests as workflow evidence, not screenshots for their own sake. Review +whether changed support flows have coverage for the state that changed: +keyboard/focus behavior, responsive layout, loading, empty, error, offline, and +permission-denied states. + +Do not accept a visual or smoke update that only refreshes snapshots while +removing assertions about privacy posture, source grounding, local-model +availability, or backend error handling.