Skip to content

Fix xPath validator link in troubleshooting docs - #2781

Open
cyrilbois wants to merge 1 commit into
SeleniumHQ:trunkfrom
cyrilbois:fix-link-troubleshooting-page
Open

Fix xPath validator link in troubleshooting docs#2781
cyrilbois wants to merge 1 commit into
SeleniumHQ:trunkfrom
cyrilbois:fix-link-troubleshooting-page

Conversation

@cyrilbois

Copy link
Copy Markdown

Description

Fix the XPath Validator link in the WebDriver troubleshooting documentation.

The existing XPath Validator link points to FreeFormatter, which is being retired and is no longer available. This change replaces it with the XMLable XPath Validator.

Motivation and Context

The FreeFormatter website is being retired and the existing XPath Validator page is no longer available.

I replaced it with XMLable (https://xmlable.com/xpath/), an XPath testing and validation service that I maintain.

Types of changes

  • Change to the site (I have double-checked the Netlify deployment, and my changes look good)
  • Code example added (and I also added the example to all translated languages)
  • Improved translation
  • Added new translation (and I also added a notice to each document missing translation)

Checklist

  • I have read the contributing document.
  • I have used hugo to render the site/docs locally and I am sure it works.

@netlify

netlify Bot commented Aug 22, 2026

Copy link
Copy Markdown

👷 Deploy request for selenium-dev pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit daae323

@CLAassistant

CLAassistant commented Aug 22, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@qodo-code-review

Copy link
Copy Markdown
Contributor

PR Summary by Qodo

Replace retired FreeFormatter XPath Validator link in WebDriver troubleshooting docs

📝 Documentation 🕐 Less than 5 minutes

Grey Divider

AI Description

• Replace the retired FreeFormatter XPath Validator link with XMLable.
• Apply the same link fix across English and translated troubleshooting pages.
Diagram

graph TD
  A(["selenium.dev docs site"]) --> B["Troubleshooting pages"] --> C{{"XMLable XPath Validator"}}
  subgraph Legend
    direction LR
    _site(["Docs site"]) ~~~ _doc["Doc page"] ~~~ _ext{{"External service"}}
  end
Loading
High-Level Assessment

The following are alternative approaches to this PR:

1. Add automated link checking in CI
  • ➕ Prevents future dead-link regressions across all docs pages and translations
  • ➕ Reduces maintenance burden by detecting breakage early
  • ➖ Adds CI complexity and potentially flaky failures due to transient network issues
  • ➖ May require allowlists/retries/timeouts to keep signal high
2. Replace with an archived FreeFormatter link (e.g., Wayback Machine)
  • ➕ Keeps the originally referenced tool and page content available
  • ➕ Avoids changing to a different third-party UI/workflow
  • ➖ Archives can be slow/unreliable and are not ideal as primary references
  • ➖ Unclear longevity and potential functional limitations vs a live service

Recommendation: The chosen approach (swap to a live replacement service) is the best fit for user experience and long-term stability. As a follow-up improvement, consider CI link checking to catch future external link retirements across localized content.

Files changed (4) +4 / -4

Documentation (4) +4 / -4
_index.en.mdUpdate XPath validator link in English troubleshooting docs +1/-1

Update XPath validator link in English troubleshooting docs

• Replaces the deprecated FreeFormatter XPath tester URL with the XMLable XPath Validator link in the WebDriver troubleshooting errors page.

website_and_docs/content/documentation/webdriver/troubleshooting/errors/_index.en.md

_index.ja.mdUpdate XPath validator link in Japanese troubleshooting docs +1/-1

Update XPath validator link in Japanese troubleshooting docs

• Updates the XPath validator bullet to point to XMLable instead of the retired FreeFormatter link, keeping the Japanese translation aligned with the English page.

website_and_docs/content/documentation/webdriver/troubleshooting/errors/_index.ja.md

_index.pt-br.mdUpdate XPath validator link in pt-BR troubleshooting docs +1/-1

Update XPath validator link in pt-BR troubleshooting docs

• Replaces the FreeFormatter XPath tester URL with the XMLable XPath Validator link in the pt-BR troubleshooting errors page.

website_and_docs/content/documentation/webdriver/troubleshooting/errors/_index.pt-br.md

_index.zh-cn.mdUpdate XPath validator link in zh-CN troubleshooting docs +1/-1

Update XPath validator link in zh-CN troubleshooting docs

• Updates the XPath validator reference to XMLable in the zh-CN troubleshooting errors page, replacing the now-unavailable FreeFormatter link.

website_and_docs/content/documentation/webdriver/troubleshooting/errors/_index.zh-cn.md

@qodo-code-review

Copy link
Copy Markdown
Contributor

Code Review by Qodo

🐞 Bugs (1) 📘 Rule violations (0) 📜 Skill insights (0)

Grey Divider


Informational

1. Inconsistent XPath capitalization 🐞 Bug ⚙ Maintainability
Description
The link text uses "xPath" instead of the standard "XPath", which is inconsistent with the
surrounding documentation wording and can look unpolished. This is present on all updated-language
copies of the page.
Code

website_and_docs/content/documentation/webdriver/troubleshooting/errors/_index.en.md[29]

+* [xPath Validator](https://xmlable.com/xpath/)
Evidence
The PR changes the URL but leaves the link label as "xPath" on each modified page; the surrounding
text uses "XPath", so the label capitalization is inconsistent.

website_and_docs/content/documentation/webdriver/troubleshooting/errors/_index.en.md[27-31]
website_and_docs/content/documentation/webdriver/troubleshooting/errors/_index.ja.md[21-25]
website_and_docs/content/documentation/webdriver/troubleshooting/errors/_index.pt-br.md[21-25]
website_and_docs/content/documentation/webdriver/troubleshooting/errors/_index.zh-cn.md[21-25]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
The modified markdown line uses the non-standard capitalization `xPath` in the link label. This should be `XPath` for consistency and professionalism.

## Issue Context
This wording appears in multiple translated copies of the same troubleshooting page.

## Fix Focus Areas
- website_and_docs/content/documentation/webdriver/troubleshooting/errors/_index.en.md[29-29]
- website_and_docs/content/documentation/webdriver/troubleshooting/errors/_index.ja.md[23-23]
- website_and_docs/content/documentation/webdriver/troubleshooting/errors/_index.pt-br.md[23-23]
- website_and_docs/content/documentation/webdriver/troubleshooting/errors/_index.zh-cn.md[23-23]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

Context sources
✅ Compliance rules (platform): 10 rules

Grey Divider

Tip of the day
💡 Did you know, you can commit Qodo's fix in one click with committable suggestions (GitHub & GitLab)

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

Run your selector through a validator service:
* [CSS Validator](http://csslint.net/)
* [xPath Validator](http://www.freeformatter.com/xpath-tester.html)
* [xPath Validator](https://xmlable.com/xpath/)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Informational

1. Inconsistent xpath capitalization 🐞 Bug ⚙ Maintainability

The link text uses "xPath" instead of the standard "XPath", which is inconsistent with the
surrounding documentation wording and can look unpolished. This is present on all updated-language
copies of the page.
Agent Prompt
## Issue description
The modified markdown line uses the non-standard capitalization `xPath` in the link label. This should be `XPath` for consistency and professionalism.

## Issue Context
This wording appears in multiple translated copies of the same troubleshooting page.

## Fix Focus Areas
- website_and_docs/content/documentation/webdriver/troubleshooting/errors/_index.en.md[29-29]
- website_and_docs/content/documentation/webdriver/troubleshooting/errors/_index.ja.md[23-23]
- website_and_docs/content/documentation/webdriver/troubleshooting/errors/_index.pt-br.md[23-23]
- website_and_docs/content/documentation/webdriver/troubleshooting/errors/_index.zh-cn.md[23-23]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

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