Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes #1063 Help/user guide display in workbench landing page and broken links in the guide #1069

Open
wants to merge 5 commits into
base: develop
Choose a base branch
from

Conversation

chandrikarj
Copy link
Contributor

@chandrikarj chandrikarj commented Jan 13, 2025

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:

  1. Help/User Guide Modal: The modal was not displaying properly because of incorrect placement. The modal's

    has now been moved before the navbar options to ensure proper initialization and functionality.

  2. 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

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:
Screenshot 2025-01-08 at 10 37 53 PM
Screenshot 2025-01-13 at 8 48 46 PM

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.

@chandrikarj chandrikarj changed the title Fixex Help/user guide display in workbench landing page and broken links in the guide Fixes #1063 Help/user guide display in workbench landing page and broken links in the guide Jan 13, 2025
Copy link
Member

@birm birm left a comment

Choose a reason for hiding this comment

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

Please preview the markdown images; they are not links, that's how github does embedding.

@chandrikarj
Copy link
Contributor Author

chandrikarj commented Jan 23, 2025

Hi @birm,

Thank you for the clarification earlier. Initially, the markdown images were rendering correctly on GitHub but were not displaying on the website due to Content Security Policy (CSP) restrictions, hence I had changed them to links.
The browser console indicated that the policy only permits image sources from 'self', data:, cdn.datatables.net, and code.jquery.com, which resulted in external image links (e.g., i.ibb.co) being blocked.

Screenshot 2025-01-24 at 4 20 27 AM

To address this issue, I have added an images folder to the repository and migrated all required images and GIFs locally. The markdown files have been updated to reference these local assets, ensuring compliance with the existing CSP policy.

The images are now displaying correctly on the website and on GitHub. Please let me know if any additional adjustments are required.

Thanks!

Screen.Recording.2025-01-24.at.4.07.56.AM.mov

@chandrikarj chandrikarj requested a review from birm January 25, 2025 14:55
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