feat(desktop): help button and settings improvement by AviPeltz · Pull Request #448 · superset-sh/superset

AviPeltz · 2025-12-20T19:20:55Z

Description

Related Issues

Type of Change

Bug fix
New feature
Documentation
[ x] Refactor
Other (please describe):

Testing

Screenshots (if applicable)

Additional Notes

Summary by CodeRabbit

Style
- Refreshed Help menu with updated icon, inline label, and tooltip text ("Get help & support")
- Enhanced Settings button with new icon and improved tooltip label ("Open settings")
- Adjusted Help menu positioning within the workspace interface

_{✏️ Tip: You can customize this high-level summary in your review settings.}

coderabbitai · 2025-12-20T19:21:01Z

Walkthrough

This PR refactors the Help menu and Settings button components in the desktop renderer, updating their visual appearance, tooltip behavior, and positioning. SettingsButton is relocated to a shared directory and the HelpMenu is moved from TopBar to WorkspaceHeader, requiring corresponding import path adjustments across multiple files.

Changes

Cohort / File(s)	Summary
Help & Settings Menu UI Updates `apps/desktop/src/renderer/screens/main/components/HelpMenu/HelpMenu.tsx`, `apps/desktop/src/renderer/screens/main/components/SettingsButton/SettingsButton.tsx`	HelpMenu: Replaces QuestionMarkCircle icon with LifeBuoy icon and adds inline "Help" label; updates tooltip to "Get help & support" and repositions dropdown from bottom-end to top-start. SettingsButton: Replaces native button with Button component (ghost variant), swaps icon from HiOutlineCog6Tooth to CiSettings, updates tooltip text to "Open settings" with bottom placement.
Component Relocation & Import Reorganization `apps/desktop/src/renderer/screens/main/components/TopBar/index.tsx`, `apps/desktop/src/renderer/screens/main/components/StartView/StartTopBar.tsx`, `apps/desktop/src/renderer/screens/main/components/WorkspaceView/WorkspaceHeader/WorkspaceHeader.tsx`	Removes HelpMenu import/usage from TopBar; updates SettingsButton import paths to shared location (`../SettingsButton`); adds HelpMenu import and renders it alongside branch info in WorkspaceHeader left container.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Visual and tooltip styling updates with straightforward icon/label swaps
Import path reorganization is mechanical and low-risk
Each file contains isolated, focused changes with minimal interdependencies
No complex logic modifications or behavioral flow changes

Possibly related PRs

feat(desktop): add help menu to top bar #259: Both PRs modify HelpMenu feature and component presentation (icon, label, tooltip content, positioning)
Add tooltips with keyboard shortcuts to topbar buttons #231: Both PRs update SettingsButton's tooltip wrapper, styling, and icon presentation
color change on settings button #191: Both PRs refactor SettingsButton component styling and icon choices

Poem

🐰 A bunny hops through menus old and new,
Help and Settings find their rightful place,
With lifesavers and gears in shiny hue,
The UI dances at a faster pace! ✨

Pre-merge checks and finishing touches

❌ Failed checks (2 warnings)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The PR description follows the required template structure but is largely empty, providing no concrete information about changes, testing, or context despite marking 'Refactor' as the type.	Fill in the Description section explaining what was refactored and why; provide Testing steps to verify the UI changes; consider linking related issues if applicable.
Docstring Coverage	⚠️ Warning	Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%.	You can run `@coderabbitai generate docstrings` to improve docstring coverage.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly summarizes the main changes: improvements to the help button and settings components with updated visuals, positioning, and styling across multiple files.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch disgusted-lamprey-87c9f0

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ae1929a and 023b33e.

📒 Files selected for processing (5)

apps/desktop/src/renderer/screens/main/components/HelpMenu/HelpMenu.tsx (2 hunks)
apps/desktop/src/renderer/screens/main/components/SettingsButton/SettingsButton.tsx (2 hunks)
apps/desktop/src/renderer/screens/main/components/StartView/StartTopBar.tsx (1 hunks)
apps/desktop/src/renderer/screens/main/components/TopBar/index.tsx (1 hunks)
apps/desktop/src/renderer/screens/main/components/WorkspaceView/WorkspaceHeader/WorkspaceHeader.tsx (2 hunks)

🧰 Additional context used

📓 Path-based instructions (9)

apps/desktop/**/*.{ts,tsx,js,jsx}

📄 CodeRabbit inference engine (apps/desktop/AGENTS.md)

apps/desktop/**/*.{ts,tsx,js,jsx}: For Electron interprocess communication, ALWAYS use trpc as defined in src/lib/trpc
Use alias as defined in tsconfig.json when possible
Prefer zustand for state management if it makes sense. Do not use effect unless absolutely necessary.

Files:

apps/desktop/src/renderer/screens/main/components/WorkspaceView/WorkspaceHeader/WorkspaceHeader.tsx
apps/desktop/src/renderer/screens/main/components/SettingsButton/SettingsButton.tsx
apps/desktop/src/renderer/screens/main/components/TopBar/index.tsx
apps/desktop/src/renderer/screens/main/components/HelpMenu/HelpMenu.tsx
apps/desktop/src/renderer/screens/main/components/StartView/StartTopBar.tsx

**/*.{ts,tsx}