Skip to content

Commit ea1319e

Browse files
authored
Add keyboard shortcuts reference documentation - DOCS-1659 (#1461)
=
1 parent 807d099 commit ea1319e

4 files changed

Lines changed: 53 additions & 2 deletions

File tree

content/en/guides/models/app/features/custom-charts/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ menu:
44
identifier: intro
55
parent: w-b-app-ui-reference
66
title: Custom charts
7-
weight: 2
7+
weight: 3
88
url: guides/app/features/custom-charts
99
cascade:
1010
- url: guides/app/features/custom-charts/:filename

content/en/guides/models/app/features/panels/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ menu:
44
identifier: intro_panels
55
parent: w-b-app-ui-reference
66
title: Panels
7-
weight: 1
7+
weight: 2
88
url: guides/app/features/panels
99
cascade:
1010
- url: guides/app/features/panels/:filename
Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
description: Learn about the keyboard shortcuts available in the W&B App.
3+
menu:
4+
default:
5+
identifier: keyboard-shortcuts
6+
parent: app
7+
title: Keyboard shortcuts
8+
weight: 1
9+
---
10+
11+
The W&B App supports keyboard shortcuts to help you navigate and interact with experiments, workspaces, and data more efficiently. This reference guide covers all available keyboard shortcuts organized by functional area.
12+
13+
## Workspace Management
14+
15+
| Shortcut | Description |
16+
|----------|-------------|
17+
| **Cmd+Z** (macOS) / **Ctrl+Z** (Windows/Linux) | Undo a change you've made in the UI, such as a modification to the workspace or a panel. |
18+
| **Cmd+Shift+Z** (macOS) / **Ctrl+Y** (Windows/Linux) | Redo a change you previously undid in the workspace. |
19+
20+
## Navigation
21+
22+
| Shortcut | Description |
23+
|----------|-------------|
24+
| **Tab** | Navigate between interactive elements. |
25+
| **Cmd+J** (macOS) / **Ctrl+J** (Windows/Linux) | Switch between the Workspaces and Runs tabs in the sidebar. |
26+
| **Cmd+K** (macOS) / **Ctrl+K** (Windows/Linux) | Open the quick search dialog to search across projects, runs, and other resources. |
27+
| **Esc** | Throughout the W&B App, exit full-screen panel views, close settings drawers, dismiss the quick search dialog, close an editor, or dismiss other overlays. |
28+
29+
## Panel Navigation
30+
31+
| Shortcut | Description |
32+
|----------|-------------|
33+
| **Left Arrow / Right Arrow** | Step through panels in a section when in full screen mode. |
34+
| **Esc** | Exit full-screen panel view and return to the workspace. |
35+
| **Cmd+Left Arrow / Cmd+Right Arrow** (macOS)<br>**Ctrl+Left Arrow / Ctrl+Right Arrow** (Windows/Linux) | When viewing a media panel in full screen mode,move the step slider. |
36+
37+
## Reports
38+
39+
| Shortcut | Description |
40+
|----------|-------------|
41+
| **Delete / Backspace** | Remove the selected panel grid from the report. |
42+
| **Enter** | Insert a Markdown block after typing "/mark" in a report. |
43+
| **Esc** | Exit the report editor. |
44+
| **Tab** | Navigate between interactive elements in a report. |
45+
46+
## Notes
47+
48+
- Most keyboard shortcuts use **Cmd** on macOS and **Ctrl** on Windows/Linux
49+
- The W&B App implements custom handling for some browser default shortcuts.
50+
- Some shortcuts are context-sensitive and only work in specific areas of the application

content/en/guides/models/app/settings-page/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ menu:
66
identifier: settings
77
parent: w-b-app-ui-reference
88
title: Settings
9+
weight: 4
910
---
1011

1112
Within your individual user account you can edit: your profile picture, display name, geography location, biography information, emails associated to your account, and manage alerts for runs. You can also use the settings page to link your GitHub repository and delete your account. For more information, see [User settings]({{< relref "./user-settings.md" >}}).

0 commit comments

Comments
 (0)