hyperledger / caliper

A blockchain benchmark framework to measure performance of multiple blockchain solutions https://wiki.hyperledger.org/display/caliper
https://hyperledger.github.io/caliper/
Apache License 2.0
642 stars 403 forks source link

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

Closed PrathamSikka24 closed 3 months ago

PrathamSikka24 commented 3 months ago

Checklist

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 commented 3 months ago

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