Skip to content

Commit c879f4e

Browse files
[cuenimby] Fix working icon description in documentation (#2070)
**Link the Issue(s) this Pull Request is related to.** - #2061 **Summarize your change.** Update all CueNIMBY documentation to accurately describe the working state icon as having a red dot in center rather than being blue. This better represents a "busy" state visually. Changes made across 8 documentation files: - 🔴 **Working** (`opencue-working.png`): Currently rendering frames (red dot in center) - Updated emoji from 🔵 to 🔴 in state descriptions - Changed "Blue icon" to "Icon with red dot in center" in icon galleries - Fixed "turns blue" to "shows red dot in center" in tutorials - Corrected "Checked (🟢/🔵)" to "Checked (🟢/🔴)" in user guide - Added clarification "(red dot in center)" where appropriate Updated files: - cuenimby/README.md - docs/_docs/concepts/nimby.md - docs/_docs/developer-guide/cuenimby-development.md - docs/_docs/other-guides/desktop-rendering-control.md - docs/_docs/quick-starts/quick-start-cuenimby.md - docs/_docs/reference/tools/cuenimby.md - docs/_docs/tutorials/cuenimby-tutorial.md - docs/_docs/user-guides/cuenimby-user-guide.md
1 parent 271e69a commit c879f4e

File tree

8 files changed

+20
-20
lines changed

8 files changed

+20
-20
lines changed

cuenimby/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ CueNIMBY is a cross-platform system tray application that provides user control
77
- **System Tray Icon with OpenCue Logo**: Visual indication of current rendering state with professional icons
88
- 🔄 **Starting**: Application is initializing
99
- 🟢 **Available** (`opencue-available.png`): Host is idle and ready for rendering
10-
- 🔵 **Working** (`opencue-working.png`): Currently rendering frames
10+
- 🔴 **Working** (`opencue-working.png`): Currently rendering frames (red dot in center)
1111
- 🔴 **Disabled** (`opencue-disabled.png`):
1212
- NIMBY locked (🔒 due to user activity)
1313
- Host locked (🔒 manually disabled)
@@ -251,7 +251,7 @@ All icons feature the OpenCue logo for professional appearance:
251251
|-----------|-------|-------|-------------|
252252
| `opencue-starting.png` | Starting | 🔄 | Application is initializing |
253253
| `opencue-available.png` | Available | 🟢 | Host is idle and ready for rendering |
254-
| `opencue-working.png` | Working | 🔵 | Currently rendering frames |
254+
| `opencue-working.png` | Working | 🔴 | Currently rendering frames (red dot in center) |
255255
| `opencue-disabled.png` | Disabled/Locked/Down | 🔴 | NIMBY locked, Host locked, or Host down |
256256
| `opencue-error.png` | Error/Unreachable || CueBot unreachable or host not found |
257257
| `opencue-warning.png` | Warning/Lagging | ⚠️ | Host ping above 60 second limit |
@@ -266,7 +266,7 @@ Here are all the CueNIMBY icons with the OpenCue logo:
266266
| Icon | Name | Description |
267267
|------|------|-------------|
268268
| ![Available](cuenimby/icons/opencue-available.png) | `opencue-available.png` | Green icon - Host ready for rendering |
269-
| ![Working](cuenimby/icons/opencue-working.png) | `opencue-working.png` | Blue icon - Currently rendering |
269+
| ![Working](cuenimby/icons/opencue-working.png) | `opencue-working.png` | Icon with red dot in center - Currently rendering |
270270
| ![Disabled](cuenimby/icons/opencue-disabled.png) | `opencue-disabled.png` | Red icon - Host locked/disabled |
271271
| ![Error](cuenimby/icons/opencue-error.png) | `opencue-error.png` | Red X icon - Connection error |
272272
| ![Warning](cuenimby/icons/opencue-warning.png) | `opencue-warning.png` | Yellow icon - Warning state |

docs/_docs/concepts/nimby.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ Workstations can be in one of several states. CueNIMBY displays these with profe
9797
|-------|------|-------|-------------|
9898
| **STARTING** | `opencue-starting.png` | 🔄 | Application is initializing |
9999
| **AVAILABLE** | `opencue-available.png` | 🟢 | Host is unlocked and idle, ready to accept jobs |
100-
| **WORKING** | `opencue-working.png` | 🔵 | Host is unlocked and actively running frames |
100+
| **WORKING** | `opencue-working.png` | 🔴 | Host is unlocked and actively running frames (red dot in center) |
101101
| **DISABLED** | `opencue-disabled.png` | 🔴 | Host is manually locked (via CueGUI or CueNIMBY) |
102102
| **NIMBY_LOCKED** | `opencue-disabled.png` | 🔒 | Host is locked by NIMBY due to user activity |
103103
| **HOST_DOWN** | `opencue-disabled.png` || RQD is not running on the host |
@@ -114,7 +114,7 @@ All CueNIMBY icons feature the OpenCue logo for professional appearance:
114114
| Icon | File | Description |
115115
|------|------|-------------|
116116
| ![Available](/assets/images/cuenimby/icons/opencue-available.png) | `opencue-available.png` | Green - Ready for rendering |
117-
| ![Working](/assets/images/cuenimby/icons/opencue-working.png) | `opencue-working.png` | Blue - Currently rendering |
117+
| ![Working](/assets/images/cuenimby/icons/opencue-working.png) | `opencue-working.png` | Icon with red dot in center - Currently rendering |
118118
| ![Disabled](/assets/images/cuenimby/icons/opencue-disabled.png) | `opencue-disabled.png` | Red - Locked/disabled |
119119
| ![Error](/assets/images/cuenimby/icons/opencue-error.png) | `opencue-error.png` | Red X - Error/unreachable |
120120
| ![Warning](/assets/images/cuenimby/icons/opencue-warning.png) | `opencue-warning.png` | Yellow - Warning/lagging |

docs/_docs/developer-guide/cuenimby-development.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -439,7 +439,7 @@ logging.getLogger('cuenimby.scheduler').setLevel(logging.DEBUG)
439439

440440
**Icon files**:
441441
* `opencue-available.png` - Green (ready)
442-
* `opencue-working.png` - Blue (rendering)
442+
* `opencue-working.png` - Icon with red dot in center (rendering)
443443
* `opencue-disabled.png` - Red (locked/down)
444444
* `opencue-error.png` - Red with X (error/unreachable)
445445
* `opencue-warning.png` - Yellow (warning/lagging)
@@ -455,7 +455,7 @@ All icons are located in `cuenimby/icons/` and feature the OpenCue logo:
455455
| Icon | File | Description |
456456
|------|------|-------------|
457457
| ![Available](/assets/images/cuenimby/icons/opencue-available.png) | `opencue-available.png` | Green - Host ready for rendering |
458-
| ![Working](/assets/images/cuenimby/icons/opencue-working.png) | `opencue-working.png` | Blue - Currently rendering |
458+
| ![Working](/assets/images/cuenimby/icons/opencue-working.png) | `opencue-working.png` | Icon with red dot in center - Currently rendering |
459459
| ![Disabled](/assets/images/cuenimby/icons/opencue-disabled.png) | `opencue-disabled.png` | Red - Host locked/disabled |
460460
| ![Error](/assets/images/cuenimby/icons/opencue-error.png) | `opencue-error.png` | Red X - Connection error |
461461
| ![Warning](/assets/images/cuenimby/icons/opencue-warning.png) | `opencue-warning.png` | Yellow - Warning/lagging |

docs/_docs/other-guides/desktop-rendering-control.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ CueNIMBY displays these states with professional icons featuring the OpenCue log
4848
|-------|-----------|-------|-----------|-------------|
4949
| **STARTING** | `opencue-starting.png` | 🔄 | N/A | Application is initializing |
5050
| **AVAILABLE** | `opencue-available.png` | 🟢 | Not locked | Host is idle and ready to accept jobs |
51-
| **WORKING** | `opencue-working.png` | 🔵 | Not locked | Host is actively running frames |
51+
| **WORKING** | `opencue-working.png` | 🔴 | Not locked | Host is actively running frames (red dot in center) |
5252
| **DISABLED** | `opencue-disabled.png` | 🔴 | Manual lock | User manually disabled rendering via CueGUI or CueNIMBY |
5353
| **NIMBY_LOCKED** | `opencue-disabled.png` | 🔒 | Automatic lock | RQD locked the host due to user activity (keyboard/mouse) |
5454
| **HOST_DOWN** | `opencue-disabled.png` || System issue | RQD is not running on the host |
@@ -65,7 +65,7 @@ All CueNIMBY icons feature the OpenCue logo:
6565
| Icon | File | Description |
6666
|------|------|-------------|
6767
| ![Available](/assets/images/cuenimby/icons/opencue-available.png) | `opencue-available.png` | Green - Ready for rendering |
68-
| ![Working](/assets/images/cuenimby/icons/opencue-working.png) | `opencue-working.png` | Blue - Currently rendering |
68+
| ![Working](/assets/images/cuenimby/icons/opencue-working.png) | `opencue-working.png` | Icon with red dot in center - Currently rendering |
6969
| ![Disabled](/assets/images/cuenimby/icons/opencue-disabled.png) | `opencue-disabled.png` | Red - Locked/disabled |
7070
| ![Error](/assets/images/cuenimby/icons/opencue-error.png) | `opencue-error.png` | Red X - Error/unreachable |
7171
| ![Warning](/assets/images/cuenimby/icons/opencue-warning.png) | `opencue-warning.png` | Yellow - Warning/lagging |

docs/_docs/quick-starts/quick-start-cuenimby.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ If you're using the OpenCue sandbox environment, CueNIMBY is automatically insta
8484
2. Look for the CueNIMBY icon in your system tray (professional icons with OpenCue logo):
8585
* 🔄 **Starting** (`opencue-starting.png`): Application is initializing
8686
* 🟢 **Available** (`opencue-available.png`): Host is idle and ready for rendering
87-
* 🔵 **Working** (`opencue-working.png`): Currently rendering frames
87+
* 🔴 **Working** (`opencue-working.png`): Currently rendering frames (red dot in center)
8888
* 🔴 **Disabled** (`opencue-disabled.png`): Manually locked, NIMBY locked, or host down
8989
***Error** (`opencue-error.png`): CueBot unreachable or machine not found on CueBot
9090
* ⚠️ **Warning** (`opencue-warning.png`): Host ping above 60 second limit
@@ -104,7 +104,7 @@ If you're using the OpenCue sandbox environment, CueNIMBY is automatically insta
104104
| Icon | File | Description |
105105
|------|------|-------------|
106106
| ![Available](/assets/images/cuenimby/icons/opencue-available.png) | `opencue-available.png` | Green - Ready for rendering |
107-
| ![Working](/assets/images/cuenimby/icons/opencue-working.png) | `opencue-working.png` | Blue - Currently rendering |
107+
| ![Working](/assets/images/cuenimby/icons/opencue-working.png) | `opencue-working.png` | Icon with red dot in center - Currently rendering |
108108
| ![Disabled](/assets/images/cuenimby/icons/opencue-disabled.png) | `opencue-disabled.png` | Red - Locked/disabled |
109109
| ![Error](/assets/images/cuenimby/icons/opencue-error.png) | `opencue-error.png` | Red X - Error/unreachable |
110110
| ![Warning](/assets/images/cuenimby/icons/opencue-warning.png) | `opencue-warning.png` | Yellow - Warning/lagging |

docs/_docs/reference/tools/cuenimby.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ All icons feature the OpenCue logo for professional appearance and consistent vi
180180
|-----------|-------|-------|-------------|
181181
| `opencue-starting.png` | 🔄 | STARTING | Application is initializing |
182182
| `opencue-available.png` | 🟢 | AVAILABLE | Host is unlocked and idle, ready to accept jobs |
183-
| `opencue-working.png` | 🔵 | WORKING | Host is unlocked and actively rendering frames |
183+
| `opencue-working.png` | 🔴 | WORKING | Host is unlocked and actively rendering frames (red dot in center) |
184184
| `opencue-disabled.png` | 🔴 | DISABLED | Host is manually locked via CueGUI or CueNIMBY |
185185
| `opencue-disabled.png` | 🔒 | NIMBY_LOCKED | Host is locked by RQD NIMBY due to user activity |
186186
| `opencue-disabled.png` || HOST_DOWN | RQD is not running on the host |
@@ -197,7 +197,7 @@ Visual representation of all CueNIMBY icons:
197197
| Icon | File | Description |
198198
|------|------|-------------|
199199
| ![Available](/assets/images/cuenimby/icons/opencue-available.png) | `opencue-available.png` | Green - Ready for rendering |
200-
| ![Working](/assets/images/cuenimby/icons/opencue-working.png) | `opencue-working.png` | Blue - Currently rendering |
200+
| ![Working](/assets/images/cuenimby/icons/opencue-working.png) | `opencue-working.png` | Icon with red dot in center - Currently rendering |
201201
| ![Disabled](/assets/images/cuenimby/icons/opencue-disabled.png) | `opencue-disabled.png` | Red - Locked/disabled |
202202
| ![Error](/assets/images/cuenimby/icons/opencue-error.png) | `opencue-error.png` | Red X - Error/unreachable |
203203
| ![Warning](/assets/images/cuenimby/icons/opencue-warning.png) | `opencue-warning.png` | Yellow - Warning/lagging |

docs/_docs/tutorials/cuenimby-tutorial.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,7 @@ Look at the tray icon (professional icons with OpenCue logo):
220220

221221
* 🔄 Starting (`opencue-starting.png`) = Application initializing
222222
* 🟢 Available (`opencue-available.png`) = Ready for rendering
223-
* 🔵 Working (`opencue-working.png`) = Currently rendering
223+
* 🔴 Working (`opencue-working.png`) = Currently rendering (red dot in center)
224224
* 🔴 Disabled (`opencue-disabled.png`) = Manually locked, NIMBY locked, or host down
225225
* ❌ Error (`opencue-error.png`) = CueBot unreachable or host not found
226226
* ⚠️ Warning (`opencue-warning.png`) = Host lagging (ping > 60s)
@@ -242,7 +242,7 @@ Visual representation of all CueNIMBY icons:
242242
| Icon | File | Description |
243243
|------|------|-------------|
244244
| ![Available](/assets/images/cuenimby/icons/opencue-available.png) | `opencue-available.png` | Green - Ready for rendering |
245-
| ![Working](/assets/images/cuenimby/icons/opencue-working.png) | `opencue-working.png` | Blue - Currently rendering |
245+
| ![Working](/assets/images/cuenimby/icons/opencue-working.png) | `opencue-working.png` | Icon with red dot in center - Currently rendering |
246246
| ![Disabled](/assets/images/cuenimby/icons/opencue-disabled.png) | `opencue-disabled.png` | Red - Locked/disabled |
247247
| ![Error](/assets/images/cuenimby/icons/opencue-error.png) | `opencue-error.png` | Red X - Error/unreachable |
248248
| ![Warning](/assets/images/cuenimby/icons/opencue-warning.png) | `opencue-warning.png` | Yellow - Warning/lagging |
@@ -327,7 +327,7 @@ Rendering: myshow/test
327327

328328
### 5.4 Watch state changes
329329

330-
* Icon turns blue (🔵) when frame starts
330+
* Icon shows red dot in center (🔴) when frame starts
331331
* Icon turns green (🟢) when frame completes
332332

333333
**Checkpoint**: You receive notifications when jobs start on your machine.
@@ -406,7 +406,7 @@ Right-click the tray icon and verify "Scheduler" is checked.
406406
* Manual toggle temporarily overrides, but scheduler resets every minute
407407

408408
**Outside work hours:**
409-
* Icon should be green (🟢) if idle, or blue (🔵) if rendering
409+
* Icon should be green (🟢) if idle, or show red dot in center (🔴) if rendering
410410

411411
**Checkpoint**: Scheduler automatically controls your workstation based on time.
412412

docs/_docs/user-guides/cuenimby-user-guide.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ The CueNIMBY tray icon uses professional icons with the OpenCue logo to indicate
117117
|-----------|-------|-------|-------------|
118118
| `opencue-starting.png` | 🔄 | Starting | Application is initializing |
119119
| `opencue-available.png` | 🟢 | Available | Your machine is idle and ready to accept rendering jobs |
120-
| `opencue-working.png` | 🔵 | Working | Your machine is currently rendering a frame |
120+
| `opencue-working.png` | 🔴 | Working | Your machine is currently rendering a frame (red dot in center) |
121121
| `opencue-disabled.png` | 🔴 | Disabled | You've manually disabled rendering via CueNIMBY or CueGUI |
122122
| `opencue-disabled.png` | 🔒 | NIMBY Locked | RQD has locked the machine due to user activity |
123123
| `opencue-disabled.png` || Host Down | RQD is not running on the host |
@@ -134,7 +134,7 @@ All CueNIMBY icons feature the OpenCue logo for professional appearance and cons
134134
| Icon | Name | Description |
135135
|------|------|-------------|
136136
| ![Available](/assets/images/cuenimby/icons/opencue-available.png) | `opencue-available.png` | Green icon - Host ready for rendering |
137-
| ![Working](/assets/images/cuenimby/icons/opencue-working.png) | `opencue-working.png` | Blue icon - Currently rendering |
137+
| ![Working](/assets/images/cuenimby/icons/opencue-working.png) | `opencue-working.png` | Icon with red dot in center - Currently rendering |
138138
| ![Disabled](/assets/images/cuenimby/icons/opencue-disabled.png) | `opencue-disabled.png` | Red icon - Host locked/disabled |
139139
| ![Error](/assets/images/cuenimby/icons/opencue-error.png) | `opencue-error.png` | Red X icon - Connection error |
140140
| ![Warning](/assets/images/cuenimby/icons/opencue-warning.png) | `opencue-warning.png` | Yellow icon - Warning state |
@@ -164,7 +164,7 @@ Right-click the CueNIMBY icon to open the menu.
164164

165165
Controls whether your machine accepts rendering jobs.
166166

167-
**Checked** (🟢/🔵): Machine is available for rendering
167+
**Checked** (🟢/🔴): Machine is available for rendering
168168
* Jobs can be dispatched to your machine
169169
* Currently running jobs continue
170170

0 commit comments

Comments
 (0)