Fixes #1063 Help/user guide display in workbench landing page and broken links in the guide by chandrikarj · Pull Request #1069 · camicroscope/caMicroscope
Fixes #1063 Help/User Guide display in Workbench landing page and resolve broken links in the guide
to a position before the navbar options for correct functionality.
Verified that the modal correctly displays content fetched from readme.md.
Link Fixes:
Updated outdated links in the User Guide to point to the correct URLs.
Ensured all links in the guide work as expected and direct users to valid resources.
Before:
After:
Uploading 406238276-e49689ce-77d0-42d0-b161-2dcedf9bdb88.mov…
Motivation
The Help/User Guide is a critical feature for onboarding new users and assisting with navigation. The broken functionality and links reduced usability and caused confusion. These fixes ensure the guide is accessible, accurate, and user-friendly.
Testing
The changes have been tested in the following ways:
Guide Rendering:
Confirmed that the readme.md file is correctly fetched, parsed, and displayed in the modal on the Workbench landing page.
Link Validation:
Tested all links in the guide to ensure they lead to the correct resources.
Cross-Browser Compatibility:
Verified functionality on Chrome, Brave, and Safari.