Skip to content

future-help-diagnostics.md

Latest commit

 

History

History
58 lines (46 loc) · 2.55 KB

future-help-diagnostics.md

File metadata and controls

58 lines (46 loc) · 2.55 KB

Future — Help, About, Diagnostics

The desktop has a sizeable help / about / diagnostics surface (About, Help menu, Tip-of-the-Day, log export, in-app log viewer, crash telemetry, Package Show for Support). iPad currently has the menu shell only.

Source: §2.16 of the 2026-04-23 gap analysis (Phase P + parts of pre-TestFlight Phase I).

Pre-MVP (in followups.md)

The TestFlight-quality items (H-1 About, H-2 Help menu URLs, H-3 log export, H-4 crash telemetry, T-1 Check Sequence) are tracked in followups.md under "TestFlight quality" — they're small enough to pull in without a phase commitment, and the gap analysis flagged H-3 as P0 for TestFlight.

Gap (still open after the followups land)

# Item Severity Effort
H-5 TipOfDay — 50+ HTML / PNG tips in TipOfDay/. Per-tip difficulty filter (MinimumTipLevel pref). Carousel UI. P2 M
H-6 In-app log viewer — level filter, search, follow-tail toggle. Reads the spdlog rotate-files. P2 M
H-7 Package Show for Support — zips logs + show folder + autosaves into one file the user can attach to a forum post. Larger sibling of H-3 log export. P2 M
H-10 EmailDialog (crash-report email collection) P3 S
H-11 RestoreBackupDialog full UI (paired with future-preferences.md backup section) P2 M
H-12 ShowFolderSearchDialog P3 S
T-2 View Log (Tools menu entry → opens H-6 viewer) P2 S
T-20 Package Log Files (Tools menu entry → runs H-3 log export) P2 M
T-3 Cleanup File Locations P2 S
T-9 Purge Render / Download caches P3 S
T-15 Prepare Audio (Reaper .rpp) P3 S
T-16 User Lyric Dictionary (LyricUserDictDialog) P3 S
T-22 Show Folder Search P3 S

Items handled by the platform

  • H-8 UpdaterDialog. App Store handles iPad updates — N/A.
  • H-9 SplashDialog. LaunchScreen handles it — landed in Phase H-1.

Why deferred

  • The followups bundle covers what TestFlight reviewers need. The items above are quality-of-life polish that mostly applies once the app is in front of long-term users.
  • TipOfDay (H-5) is the highest-engagement item — the desktop gets meaningful daily click-through from it. Worth pulling forward if the simple About/Help/log-export bundle ships early.

When to come back

  • After H-5 submission. Bundle TipOfDay + the in-app log viewer + Package Show for Support as a small follow-up release — they fit into a single 1–2 week sprint.