Skip to content

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

Merged
titusfortner merged 2 commits intoSeleniumHQ:trunkfrom
3dprogramin:fix-npm-docs
Jun 14, 2024
Merged

fixed docs api url in README.md for selenium-webdriver npm package#14138
titusfortner merged 2 commits intoSeleniumHQ:trunkfrom
3dprogramin:fix-npm-docs

Conversation

@3dprogramin
Copy link
Contributor

@3dprogramin 3dprogramin commented Jun 14, 2024 •
edited by qodo-code-review bot
Loading

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 •
    edited
    Loading

    CLA assistant check
    All committers have signed the CLA.

    @qodo-code-review
    Copy link
    Contributor

    qodo-code-review bot commented Jun 14, 2024

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review [1-5]

    1

    🧪 Relevant tests

    No

    🔒 Security concerns

    No

    ⚡ Key issues to review

    None

    @qodo-code-review
    Copy link
    Contributor

    qodo-code-review bot commented Jun 14, 2024

    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

    diemol
    diemol requested changes Jun 14, 2024
    View reviewed changes
    @titusfortner titusfortner merged commit 7ae0d71 into SeleniumHQ:trunk Jun 14, 2024
    @titusfortner
    Copy link
    Member

    titusfortner commented Jun 14, 2024

    thanks!

    @seedysoft seedysoft mentioned this pull request Jun 21, 2024
    Merged
    @MiguelPelegrina MiguelPelegrina mentioned this pull request Jul 12, 2024
    Merged
    @aravindb26 aravindb26 mentioned this pull request Jul 16, 2024
    Open
    @x-way x-way mentioned this pull request Jul 24, 2024
    Closed
    @x-way x-way mentioned this pull request Aug 10, 2024
    Closed
    sandeepsuryaprasad pushed a commit to sandeepsuryaprasad/selenium that referenced this pull request Oct 29, 2024
    @3dprogramin @sandeepsuryaprasad
    fixed docs api url in README.md for selenium-webdriver npm package (S…
    3b8079a 
    …eleniumHQ#14138)

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

* updated URL to point directly to the JavaScript API documentation
    @titusfortner titusfortner added B-docs API Docs; see other repo for website documentation and removed documentation labels Mar 30, 2025
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Reviewers

    @diemol diemol diemol requested changes

    @titusfortner titusfortner titusfortner approved these changes

    Assignees

    No one assigned

    Labels

    B-docs API Docs; see other repo for website documentation P-bug fix PR addresses a known issue Review effort [1-5]: 1

    Projects

    None yet

    Milestone

    No milestone

    Development

    Successfully merging this pull request may close these issues.

    4 participants

    @3dprogramin @CLAassistant @titusfortner @diemol