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

[🚀 Feature]: You should create real API documentation for WebDriverJS #13915

Closed
kupietools opened this issue May 7, 2024 · 4 comments
Closed
Labels
A-needs-triaging A Selenium member will evaluate this soon! I-enhancement Something could be better

Comments

@kupietools
Copy link

kupietools commented May 7, 2024

Feature and motivation

I would like working documentation for WebDriverJS.

Looking for the WebDriverJS API, I clicked the link https://www.selenium.dev/selenium/docs/api/javascript/index.html found on https://github.com/SeleniumHQ/selenium/wiki.

It leads to a 404 error.

So do https://www.selenium.dev/selenium/docs/api/, https://www.selenium.dev/selenium/docs/, https://www.selenium.dev/selenium/.

I can find no examples covering what I need to implement, and no documentation so I can write my own code. For instance, I can't find a code example of the type of wait I need. I found some that are close but they all use drastically different parameters in driver.wait() and I don't know how to adapt them to my purposes. Where is the documentation for what parameters driver.wait() accepts? Where is the list of methods I can use? Every google search simply returns a page with limited examples, not complete documentation, and none of the examples anyone chooses to provide is what I need.

The "documentation" at https://www.selenium.dev/documentation/ does not provide a comprehensive list of methods or parameters available for use, and is in many place completely lacking Node code examples for the general areas it does cover.

Usage example

Ideally, I would be able to click on the link for WebDriverJs API documentation on https://github.com/SeleniumHQ/selenium/wiki, and it would lead to a usable page of documentation instead of a 404 error. I would use this to write the code that I need.

@kupietools kupietools added I-enhancement Something could be better A-needs-triaging A Selenium member will evaluate this soon! labels May 7, 2024
Copy link

github-actions bot commented May 7, 2024

@kupietools, thank you for creating this issue. We will troubleshoot it as soon as we can.


Info for maintainers

Triage this issue by using labels.

If information is missing, add a helpful comment and then I-issue-template label.

If the issue is a question, add the I-question label.

If the issue is valid but there is no time to troubleshoot it, consider adding the help wanted label.

If the issue requires changes or fixes from an external project (e.g., ChromeDriver, GeckoDriver, MSEdgeDriver, W3C), add the applicable G-* label, and it will provide the correct link and auto-close the issue.

After troubleshooting the issue, please add the R-awaiting answer label.

Thank you!

@pujagani
Copy link
Contributor

pujagani commented May 8, 2024

@harsha509 might be able you guide you better regarding your concerns and possibly contribute too. Thank you!

@diemol
Copy link
Member

diemol commented May 8, 2024

Duplicate of #10185

@diemol diemol marked this as a duplicate of #10185 May 8, 2024
@diemol diemol closed this as not planned Won't fix, can't repro, duplicate, stale May 8, 2024
Copy link

github-actions bot commented Jun 7, 2024

This issue has been automatically locked since there has not been any recent activity since it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked and limited conversation to collaborators Jun 7, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A-needs-triaging A Selenium member will evaluate this soon! I-enhancement Something could be better
Projects
None yet
Development

No branches or pull requests

3 participants