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

Fix URL path in documentation link to ensure correct format #1536

Conversation

PrathamSikka24
Copy link
Contributor

@PrathamSikka24 PrathamSikka24 commented Apr 12, 2024

Checklist

  • A link to the issue/user story that the pull request relates to
  • How to recreate the problem without the fix
  • Design of the fix
  • How to prove that the fix works
  • Automated tests that prove the fix keeps on working
  • Documentation - any JSDoc, website, or Stackoverflow answers?

Issue/User story

The pull request addresses an issue where the documentation link on the landing page generates a URL with an incorrect path, specifically introducing double slashes (//) after the version number, leading to inconsistent URL formatting.

Steps to Reproduce

  1. Navigate to the landing page.
  2. Hover over the documentation link.
  3. Observe the URL preview at the bottom left of the browser window, which incorrectly shows // after the version number.

Existing issues

Design of the fix

The fix involved removing the additional slash from the href attribute in the anchor tag for the documentation link. This approach was chosen because it directly addresses the root cause of the issue - an extra slash introduced in the URL path, ensuring that URLs are generated correctly without manual intervention or further processing.

Validation of the fix

Manual testing was conducted to confirm that the URL is now correctly formatted without double slashes.

Automated Tests

No new automated tests were added as the fix is straightforward and does not introduce new functionality. Existing tests ensure that the documentation links are accessible and lead to the correct pages.

What documentation has been provided for this pull request

N/A - The change does not introduce new functionality or concepts that require additional documentation beyond the code change itself.

@davidkel
Copy link
Contributor

@PrathamSikka24 you fixed this in #1532 so I'm closing this PR

@davidkel davidkel closed this Apr 14, 2024
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