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

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

Merged
merged 2 commits into from
Jun 14, 2024
Merged

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

merged 2 commits into from
Jun 14, 2024

Conversation

3dprogramin
Copy link
Contributor

@3dprogramin 3dprogramin commented Jun 14, 2024

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

  • 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

  • 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
    Copy link

    CLAassistant commented Jun 14, 2024

    CLA assistant check
    All committers have signed the CLA.

    Copy link
    Contributor

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review [1-5]

    1

    🧪 Relevant tests

    No

    🔒 Security concerns

    No

    ⚡ Key issues to review

    None

    Copy link
    Contributor

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    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]

    -[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 titusfortner merged commit 7ae0d71 into SeleniumHQ:trunk Jun 14, 2024
    1 check passed
    @titusfortner
    Copy link
    Member

    thanks!

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants