Skip to content

[MDS-6781] - Improve MineSpace User Guidance#3882

Merged
matbusby-fw merged 2 commits intodevelopfrom
mds-6781-minespace-user-guidance
Apr 9, 2026
Merged

[MDS-6781] - Improve MineSpace User Guidance#3882
matbusby-fw merged 2 commits intodevelopfrom
mds-6781-minespace-user-guidance

Conversation

@matbusby-fw
Copy link
Copy Markdown
Collaborator

Objective

To improve user access to training resources, this PR enhances the MineSpace application by directing users to guidance documents when needed. This includes updating the top-right help icon and adding a prominent link in the side navigation.

MDS-6781

Key Changes

  • Common Components: Updated HelpGuide.tsx in @mds/common to support an optional showText prop, allowing the "Help" label to be displayed next to the question mark icon.
  • MineSpace Header: Relabeled the question mark icon in the top right to "? Help" to improve discoverability.
  • Side Navigation: Added a new "How to use MineSpace" item to the sidebar, positioned just above "User Access".
  • Guidance Resources: Integrated the MineSpace_User_Guide_2026.pdf as a central resource, which opens in a new tab when clicked from the side navigation.
  • Tests: Updated snapshots for affected components to reflect navigation and layout changes.

Acceptance Criteria (AC)

  • Add a new page/link to the side nav in MineSpace.
  • [x] Direct the user to the guidance in the application.
  • Maintain a central place for version control (PDF asset).
  • Add a new section called “How to use MineSpace” to the side nav (placed above User Access).
  • Link opens in a new tab.
  • Update Question Mark icon in top right: Relabel the button to “? Help”.

Testing Plan

  • Header Help Icon: Navigate to any page in MineSpace and verify the help icon in the top right is now labeled with "Help".
  • Sidebar Link: Verify the sidebar contains "How to use MineSpace" above the "User Access" item.
  • New Tab Behavior: Click "How to use MineSpace" and ensure it opens the PDF guide in a new browser tab.
  • Drawer Functionality: Click the header "? Help" button and ensure the help drawer still opens correctly.

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Apr 8, 2026

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Apr 8, 2026

Quality Gate Passed Quality Gate passed for 'bcgov-sonarcloud_mds_minespace-web'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
33.3% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Apr 8, 2026

@matbusby-fw matbusby-fw added the 👍 Ready for review Pull request has been double checked by the author and is ready for comments and feedback. label Apr 8, 2026
Copy link
Copy Markdown
Collaborator

@alazar-aot alazar-aot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!

@matbusby-fw matbusby-fw merged commit 3884d9c into develop Apr 9, 2026
17 checks passed
@matbusby-fw matbusby-fw deleted the mds-6781-minespace-user-guidance branch April 9, 2026 16:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

👍 Ready for review Pull request has been double checked by the author and is ready for comments and feedback.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants