-
-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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
[📖 Docs]: Improve resources documentation #7705
Comments
This is a list of all packages that are part of this repository.
This is a general list of 3rd party plugins developed outside of this repository (community packages)
Correct!
Yes, this is indeed not well documented. Here is an example commit of someone adding their service/plugin to this list: 3cb5937. |
@Badisi thanks for raising this issue. It is very important to be very clear about this to incentivise the community to build more plugins and make the WebdriverIO ecosystem richer. I added a commit to be more clear about this. Please review and let me know what you think. Happy to extend the docs further. Also let me know where else you see a lack of documentation. Thank you for your contributions! |
All the 3rd-parties listed in services.json are only visible when using the wdio installer. That way, people would be aware of that "rich ecosystem" even before starting using wdio. |
Yes, makes sense. |
Done in webdriverio/awesome-webdriverio#4. |
Pre-check
Describe the improvement
Unclear documentation
Description of the improvement / report
While looking for resources (plugins and such):
I first went to the github page and found this list:
https://github.com/webdriverio/webdriverio#package-packages
Then I went to the website and found this other list (which is not the same):
https://webdriver.io/community/resources#plugins
I also found this repo which I guess is used to generate the page on the website:
https://github.com/webdriverio/awesome-webdriverio
And finally, I found on the doc that if you develop something yourself you should reference it here:
https://github.com/webdriverio/webdriverio/blob/main/scripts/docs-generation/3rd-party/services.json
But those are found nowhere..
I don't know how but I'm sure there is something to do here to improve user adoption as it was painfull for me to find all those info.
Code of Conduct
The text was updated successfully, but these errors were encountered: