Fixes #1063 Help/user guide display in workbench landing page and broken links in the guide #1069
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #1063 Help/User Guide display in Workbench landing page and resolve broken links in the guide
Summary
This PR fixes the following issues on the Workbench landing page:
Help/User Guide Modal: The modal was not displaying properly because of incorrect placement. The modal's
Broken Links in the User Guide: Several links in the User Guide were outdated or broken, causing users to encounter dead ends. These links have been updated to point to the correct resources or removed if they were no longer relevant.
Changes Made:
Modal Fix:
Moved the Help/User-Guide Modal
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:
![Screenshot 2025-01-08 at 10 37 53 PM](https://private-user-images.githubusercontent.com/192535132/402593388-a6e64489-2aba-434a-a815-06226f0d9826.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MzkyNjExOTQsIm5iZiI6MTczOTI2MDg5NCwicGF0aCI6Ii8xOTI1MzUxMzIvNDAyNTkzMzg4LWE2ZTY0NDg5LTJhYmEtNDM0YS1hODE1LTA2MjI2ZjBkOTgyNi5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjUwMjExJTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI1MDIxMVQwODAxMzRaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT1mZTVjZDU2MmM4NTFiN2JiY2FlNDZhMzJlYjAzZGQzYWI5M2U2ODZmNTMwYWUxYzM1M2JmMmY0OWVlYWZkMjVmJlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCJ9.jQfDaVY9sgfGRu42dHsOdoW9XI3yNhLfEb-LX-1WIt8)
![Screenshot 2025-01-13 at 8 48 46 PM](https://private-user-images.githubusercontent.com/192535132/402593688-b833bf01-b029-4e81-a581-8eb31d738bd1.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MzkyNjExOTQsIm5iZiI6MTczOTI2MDg5NCwicGF0aCI6Ii8xOTI1MzUxMzIvNDAyNTkzNjg4LWI4MzNiZjAxLWIwMjktNGU4MS1hNTgxLThlYjMxZDczOGJkMS5wbmc_WC1BbXotQWxnb3JpdGhtPUFXUzQtSE1BQy1TSEEyNTYmWC1BbXotQ3JlZGVudGlhbD1BS0lBVkNPRFlMU0E1M1BRSzRaQSUyRjIwMjUwMjExJTJGdXMtZWFzdC0xJTJGczMlMkZhd3M0X3JlcXVlc3QmWC1BbXotRGF0ZT0yMDI1MDIxMVQwODAxMzRaJlgtQW16LUV4cGlyZXM9MzAwJlgtQW16LVNpZ25hdHVyZT04ZmJiYjIxZTdkMzg5OGJhN2EwMmI3OTc1Njk1ZjM0Y2I5MjAzMTE4NjA3ZGNkMzYwMTgyMGYwYjA1MmU2MzI2JlgtQW16LVNpZ25lZEhlYWRlcnM9aG9zdCJ9.VaEQpG5MpsvUJfoJe_934rmzUoKwOUJp4GJNXr8yWf0)
After:
https://github.com/user-attachments/assets/d1c14c8c-4730-4505-ba66-69b2ab0cdbcc
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.