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: add MkDocs documentation #1312
Conversation
If using a standalone Appium server, make sure the server also has the necessary | ||
[driver(s)](https://appium.io/docs/en/latest/ecosystem/drivers/) for your target platform(s)! | ||
|
||
While the Inspector is designed to work with Appium 2, it is also compatible with |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure if we even need to mention Appium 1 except of the fact it has been EOLed a while ago
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it's reasonable to mention here, given that most things in the Appium ecosystem are no longer compatible with Appium 1. There will still be a point where Appium 1-specific workarounds (such as automationName
not being guaranteed) will be dropped, and the docs updated accordingly.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this is a remarkable upgrade to our inspector docs that will greatly assist our users! thank you @eglitise !
This PR adds a fully comprehensive documentation for the Inspector. It covers things like quickstart & installation, troubleshooting, contributing guidelines, and of course, descriptions for every bit of functionality in the GUI. Also included are CI workflows for PRs and publishing.
The README will be updated in a separate PR.
Resolves #1105.