Clarify command metadata docs

This commit is contained in:
Jage9
2026-03-08 19:42:19 -04:00
parent c14a4e322d
commit 5dafc05c8e
2 changed files with 2 additions and 1 deletions

View File

@@ -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) - `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 - `W E T Y U O P ]`: Play sharps
- Multiple keys can be held/played at once - 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 - `?`: Open piano-mode help viewer
- `-` / `=`: Shift octave down/up - `-` / `=`: Shift octave down/up
- `Z`: Start, pause, or resume recording on this piano (max 30s recorded time) - `Z`: Start, pause, or resume recording on this piano (max 30s recorded time)

View File

@@ -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 - `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`) - `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 - `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 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. - 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"}`). - `visibleWhen` supports equality checks and string negation via `!` prefix (example: `{"mediaEffect": "!off"}`).