From 5dafc05c8e0d99c9545b24c370c5fd61ff63ca05 Mon Sep 17 00:00:00 2001 From: Jage9 Date: Sun, 8 Mar 2026 19:42:19 -0400 Subject: [PATCH] Clarify command metadata docs --- docs/controls.md | 2 +- docs/protocol-notes.md | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/controls.md b/docs/controls.md index 5addf65..814abd5 100644 --- a/docs/controls.md +++ b/docs/controls.md @@ -124,7 +124,7 @@ Applies to effect select, user/item list modes, item selection, item property li - `A S D F G H J K L ; '`: Play white keys (C major from C4 upward) - `W E T Y U O P ]`: Play sharps - Multiple keys can be held/played at once -- Shifted note keys are ignored; `Shift+K` opens the command palette instead +- Shifted note keys are ignored - `?`: Open piano-mode help viewer - `-` / `=`: Shift octave down/up - `Z`: Start, pause, or resume recording on this piano (max 30s recorded time) diff --git a/docs/protocol-notes.md b/docs/protocol-notes.md index bd389c6..762278e 100644 --- a/docs/protocol-notes.md +++ b/docs/protocol-notes.md @@ -114,6 +114,7 @@ This is a behavior guide for packet semantics beyond raw schemas. - `commandMetadata.mainModeActions`: server-authored labels/tooltips for server-backed main-mode commands used by the client command palette - `itemManagement.actions`: server-authored labels/tooltips and permission-key metadata for item-management actions (`transfer`, `delete`) - `adminMenu.actions`: server-authored admin root menu labels/tooltips/ordering for the authenticated user +- Maintainer note: the current server-owned command/menu metadata definitions live in `server/app/ui_metadata.py`. - Client item UI requires this metadata from the server; there is no fallback item definition map. - Client property help/type rendering is metadata-driven; it does not infer fallback types/tooltips from hardcoded key heuristics. - `visibleWhen` supports equality checks and string negation via `!` prefix (example: `{"mediaEffect": "!off"}`).