Skip to content

Adding context through copy#8556

Open
LuniMoon wants to merge 6 commits intomasterfrom
In-app-Help-management
Open

Adding context through copy#8556
LuniMoon wants to merge 6 commits intomasterfrom
In-app-Help-management

Conversation

@LuniMoon
Copy link
Copy Markdown
Collaborator

@LuniMoon LuniMoon commented Apr 30, 2026

Context:
Having a discreet "Help" button, always available in the interface maintains the door open so the user interacts with the learning content only when they feel stuck or when they need it. <- Good UI pattern.
Screenshot 2026-05-04 at 17 05 58

The issues:

  1. The generic "help" copy failed to communicate to the user what would happen after a click: "Where will this button take me?"
  2. Information permanence: can I rely on landing on a destination that will match the level of information that I require? (pointing to the right tutorial/documentation vs generic parent term).
Screenshot 2026-05-04 at 17 06 30

Observations:

  • The Event A/C dialog "Help" button changed copy and destination depending on the scope's defined 'helpPath'. <- Not necessarily bad. However this pattern isn't maintained in other dialogs.
  • Some 'helpPath' point to the parent content ("Rotate towards angle" points to "Objects" general page instead of the #angle anchor) which could mismatch user's expectations.

Changes:

  • Dialogs ditched the generic "Help" copy and now display "About [scope]" to improve system visibility (destination transparency).

A note of caution:
For multiple events 'helpPath' leads to the parent page rather than taking the user to the related anchor. The "Helpaths_audit" google sheet has been created to repair this UX issue in the future (next polishing step).

Adapting the "Help" generic copy button to give more contextual information to the user.
Matching scope with button copy.
@LuniMoon LuniMoon requested a review from 4ian as a code owner April 30, 2026 14:48
Fixing URL when button "About Events" gets pressed.
Comment thread newIDE/app/src/AssetStore/ExtensionStore/ExtensionDetailPanel.js Outdated
LuniMoon added 3 commits May 4, 2026 10:52
Remove unused `isRelativePathToDocumentationRoot` import and the
`instructionMetadata` / `instructionHelpPage` variables that were left
behind after the HelpButton was switched to a hardcoded `/events` path.
These triggered ESLint `no-unused-vars` warnings which failed CI under
the project's zero-tolerance `--max-warnings=0` rule.
Changed scopeName="Extension" to scopeName={t\Extension`}` so the string is properly picked up by Lingui and available for translators.
Going back to contextual "Help" button for selected actions / conditions rather than "learn more" button under the short description.
@LuniMoon LuniMoon force-pushed the In-app-Help-management branch from 0c6a8f3 to b6909a9 Compare May 4, 2026 16:00
Pointing to possible broken 404 destinations (example: Scene > Does scene exist -> opens 404 on Wiki)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants