fixed docs api url in README.md for selenium-webdriver npm package

3dprogramin commented 2 weeks ago

User description

Description

Inside README.md file for the nodejs library, there is an API URL pointing to an old URL that returns a 404 now. Replaced the URL with the main documentation URL.

Old URL: https://www.selenium.dev/selenium/docs/api/javascript/module/selenium-webdriver/ New URL: https://www.selenium.dev/documentation/webdriver/

Motivation and Context

I was checking the selenium-webdriver npm library and came across the invalid API documentation URL inside README.md

Types of changes

[x] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist

[x] I have read the contributing document.
[ ] My change requires a change to the documentation.
[ ] I have updated the documentation accordingly.
[ ] I have added tests to cover my changes.
[ ] All new and existing tests passed.

PR Type

Bug fix, Documentation

Description

Fixed the broken API documentation URL in the README.md file for the selenium-webdriver npm package.
Replaced the outdated URL with the main documentation URL to prevent 404 errors.

Changes walkthrough 📝

Relevant files

Documentation

README.md

Fix broken API documentation URL in README.md

javascript/node/selenium-webdriver/README.md

Updated the API documentation URL to the correct link.

Replaced the outdated URL that returned a 404 error.

+1/-1

💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

CLAassistant commented 2 weeks ago

All committers have signed the CLA.

codiumai-pr-agent-pro[bot] commented 2 weeks ago

PR Reviewer Guide 🔍

⏱️ Estimated effort to review [1-5]	1
🧪 Relevant tests	No
🔒 Security concerns	No
⚡ Key issues to review	None

codiumai-pr-agent-pro[bot] commented 2 weeks ago

PR Code Suggestions ✨

Category	Suggestion	Score
Possible issue	Verify and correct the URL to point directly to the JavaScript API documentation ___ Ensure that the new URL for the API documentation is correct and points to the intended section. The current URL seems to point to the general WebDriver documentation rather than the specific JavaScript API documentation. [javascript/node/selenium-webdriver/README.md [220]](https://github.com/SeleniumHQ/selenium/pull/14138/files#diff-117a87473e78072cba7fb99139ed44df8d515b9b9dcfd08a3c66105b65518413R220-R220) ```diff -[api]: https://www.selenium.dev/documentation/webdriver +[api]: https://www.selenium.dev/documentation/webdriver/getting_started_with_webdriver_in_javascript/ ``` - [ ] Apply this suggestion Suggestion importance[1-10]: 7 Why: The suggestion correctly identifies a potential issue with the updated URL not specifically pointing to the JavaScript API documentation. This is important for clarity and user navigation, although the existing URL does correctly lead to the WebDriver documentation.	7

titusfortner commented 2 weeks ago

thanks!

SeleniumHQ / selenium