[PR #3648] [MERGED] Move help-related items under one single menu #54286

Closed
opened 2026-04-30 23:47:58 -05:00 by GiteaMirror · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/actualbudget/actual/pull/3648
Author: @jfdoming
Created: 10/12/2024
Status: Merged
Merged: 10/14/2024
Merged by: @jfdoming

Base: masterHead: jfdoming/unified-help-experience


📝 Commits (7)

📊 Changes

118 files changed (+172 additions, -15 deletions)

View changed files

📝 packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-Import-Transactions-import-csv-file-twice-1-chromium-linux.png (+0 -0)
📝 packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-Import-Transactions-import-csv-file-twice-2-chromium-linux.png (+0 -0)
📝 packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-Import-Transactions-import-csv-file-twice-3-chromium-linux.png (+0 -0)
📝 packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-Import-Transactions-imports-transactions-from-a-CSV-file-1-chromium-linux.png (+0 -0)
📝 packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-Import-Transactions-imports-transactions-from-a-CSV-file-2-chromium-linux.png (+0 -0)
📝 packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-Import-Transactions-imports-transactions-from-a-CSV-file-3-chromium-linux.png (+0 -0)
📝 packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-closes-an-account-1-chromium-linux.png (+0 -0)
📝 packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-closes-an-account-2-chromium-linux.png (+0 -0)
📝 packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-closes-an-account-3-chromium-linux.png (+0 -0)
📝 packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-closes-an-account-4-chromium-linux.png (+0 -0)
📝 packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-closes-an-account-5-chromium-linux.png (+0 -0)
📝 packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-closes-an-account-6-chromium-linux.png (+0 -0)
📝 packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-creates-a-new-account-and-views-the-initial-balance-transaction-1-chromium-linux.png (+0 -0)
📝 packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-creates-a-new-account-and-views-the-initial-balance-transaction-2-chromium-linux.png (+0 -0)
📝 packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-creates-a-new-account-and-views-the-initial-balance-transaction-3-chromium-linux.png (+0 -0)
📝 packages/desktop-client/e2e/budget.test.js-snapshots/Budget-renders-the-summary-information-available-funds-overspent-budgeted-and-for-next-month-1-chromium-linux.png (+0 -0)
📝 packages/desktop-client/e2e/budget.test.js-snapshots/Budget-renders-the-summary-information-available-funds-overspent-budgeted-and-for-next-month-2-chromium-linux.png (+0 -0)
📝 packages/desktop-client/e2e/budget.test.js-snapshots/Budget-renders-the-summary-information-available-funds-overspent-budgeted-and-for-next-month-3-chromium-linux.png (+0 -0)
📝 packages/desktop-client/e2e/budget.test.js-snapshots/Budget-transfer-funds-to-another-category-1-chromium-linux.png (+0 -0)
📝 packages/desktop-client/e2e/budget.test.js-snapshots/Budget-transfer-funds-to-another-category-2-chromium-linux.png (+0 -0)

...and 80 more files

📄 Description

This change stemmed from a few things:

  1. Based on survey feedback, it would be really nice to have a built-in tutorial function using a library like https://github.com/kamranahmedse/driver.js. We'd want some way to trigger tutorials manually (vs only on first load).
  2. There is currently no clear location on-screen you can go to find docs. There's the 'Docs' menu in Electron, and a 'Help' sub-item in the top-left menu, but these are not that easily findable as they are tucked away.
  3. There is no UI element you can go to right now in order to trigger the 'Keyboard shortcuts' modal. You have to know to press '?'.

To start to fix these, my proposal is to put a 'Help' button in the top-right, with a sub-menu for different help-related options (just 'Documentation' and 'Keyboard shortcuts' for now). We can add a 'Tutorial' section later once we start supporting some in-app tutorials. The impact of this change is to remove the duplicate 'Help' submenu item mentioned above, and to remove the global shortcut '?' for keyboard shortcuts as this is now bound to the new menu.

image

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/actualbudget/actual/pull/3648 **Author:** [@jfdoming](https://github.com/jfdoming) **Created:** 10/12/2024 **Status:** ✅ Merged **Merged:** 10/14/2024 **Merged by:** [@jfdoming](https://github.com/jfdoming) **Base:** `master` ← **Head:** `jfdoming/unified-help-experience` --- ### 📝 Commits (7) - [`5547d32`](https://github.com/actualbudget/actual/commit/5547d3228351afa29e6e24308fbcd14bc432bb4a) Remove previous help-related elements - [`529c9b0`](https://github.com/actualbudget/actual/commit/529c9b07ec504a734a42509238af34453de8cfad) Add new 'Help' menu with multiple options - [`7ba5b95`](https://github.com/actualbudget/actual/commit/7ba5b95364a210e81c18328cff27e0ce9082a45e) Fix alignment of popovers - [`8280240`](https://github.com/actualbudget/actual/commit/82802401a4ef7c72cfe1cdb285d9c5587083b3b9) Better types - [`f3458d5`](https://github.com/actualbudget/actual/commit/f3458d58e8469b74f37b1b2af4640dd444e14353) Add release notes - [`3a22f20`](https://github.com/actualbudget/actual/commit/3a22f208b20a909f8ce968279ae4641dbf59b210) PR feedback - [`b6d9f2e`](https://github.com/actualbudget/actual/commit/b6d9f2e79ce69df5a0abf1dc4b7e50a694755062) Update vrt ### 📊 Changes **118 files changed** (+172 additions, -15 deletions) <details> <summary>View changed files</summary> 📝 `packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-Import-Transactions-import-csv-file-twice-1-chromium-linux.png` (+0 -0) 📝 `packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-Import-Transactions-import-csv-file-twice-2-chromium-linux.png` (+0 -0) 📝 `packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-Import-Transactions-import-csv-file-twice-3-chromium-linux.png` (+0 -0) 📝 `packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-Import-Transactions-imports-transactions-from-a-CSV-file-1-chromium-linux.png` (+0 -0) 📝 `packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-Import-Transactions-imports-transactions-from-a-CSV-file-2-chromium-linux.png` (+0 -0) 📝 `packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-Import-Transactions-imports-transactions-from-a-CSV-file-3-chromium-linux.png` (+0 -0) 📝 `packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-closes-an-account-1-chromium-linux.png` (+0 -0) 📝 `packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-closes-an-account-2-chromium-linux.png` (+0 -0) 📝 `packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-closes-an-account-3-chromium-linux.png` (+0 -0) 📝 `packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-closes-an-account-4-chromium-linux.png` (+0 -0) 📝 `packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-closes-an-account-5-chromium-linux.png` (+0 -0) 📝 `packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-closes-an-account-6-chromium-linux.png` (+0 -0) 📝 `packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-creates-a-new-account-and-views-the-initial-balance-transaction-1-chromium-linux.png` (+0 -0) 📝 `packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-creates-a-new-account-and-views-the-initial-balance-transaction-2-chromium-linux.png` (+0 -0) 📝 `packages/desktop-client/e2e/accounts.test.js-snapshots/Accounts-creates-a-new-account-and-views-the-initial-balance-transaction-3-chromium-linux.png` (+0 -0) 📝 `packages/desktop-client/e2e/budget.test.js-snapshots/Budget-renders-the-summary-information-available-funds-overspent-budgeted-and-for-next-month-1-chromium-linux.png` (+0 -0) 📝 `packages/desktop-client/e2e/budget.test.js-snapshots/Budget-renders-the-summary-information-available-funds-overspent-budgeted-and-for-next-month-2-chromium-linux.png` (+0 -0) 📝 `packages/desktop-client/e2e/budget.test.js-snapshots/Budget-renders-the-summary-information-available-funds-overspent-budgeted-and-for-next-month-3-chromium-linux.png` (+0 -0) 📝 `packages/desktop-client/e2e/budget.test.js-snapshots/Budget-transfer-funds-to-another-category-1-chromium-linux.png` (+0 -0) 📝 `packages/desktop-client/e2e/budget.test.js-snapshots/Budget-transfer-funds-to-another-category-2-chromium-linux.png` (+0 -0) _...and 80 more files_ </details> ### 📄 Description This change stemmed from a few things: 1. Based on survey feedback, it would be really nice to have a built-in tutorial function using a library like https://github.com/kamranahmedse/driver.js. We'd want some way to trigger tutorials manually (vs only on first load). 2. There is currently no clear location on-screen you can go to find docs. There's the 'Docs' menu in Electron, and a 'Help' sub-item in the top-left menu, but these are not that easily findable as they are tucked away. 3. There is no UI element you can go to right now in order to trigger the 'Keyboard shortcuts' modal. You have to know to press '?'. To start to fix these, my proposal is to put a 'Help' button in the top-right, with a sub-menu for different help-related options (just 'Documentation' and 'Keyboard shortcuts' for now). We can add a 'Tutorial' section later once we start supporting some in-app tutorials. The impact of this change is to remove the duplicate 'Help' submenu item mentioned above, and to remove the global shortcut '?' for keyboard shortcuts as this is now bound to the new menu. <img width="540" alt="image" src="https://github.com/user-attachments/assets/86e9459f-1825-4f70-ae80-90a43d721ff3"> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
GiteaMirror added the pull-request label 2026-04-30 23:47:58 -05:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github-starred/actual#54286