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 request: add basic usage documentation #1105

Closed
grndvl1 opened this issue Sep 21, 2023 · 3 comments · Fixed by #1312
Closed

feature request: add basic usage documentation #1105

grndvl1 opened this issue Sep 21, 2023 · 3 comments · Fixed by #1312
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@grndvl1
Copy link

grndvl1 commented Sep 21, 2023

Current Behavior

No idea how to use the tool and what to add to start a session. Documentation is lacking for someone who has no clue on programming. Needs to be easy for QA people who may not be super technical

Suggested Solution

Add documentation to creating a connection to see an emulator or a connected device

Additional Information

No response

@grndvl1 grndvl1 added the enhancement New feature or request label Sep 21, 2023
@eglitise eglitise changed the title feature request: <title>Newb documentation on Connection to Emulator feature request: add basic usage documentation Sep 22, 2023
@jlipps
Copy link
Member

jlipps commented Sep 28, 2023

@grndvl1 the tool is designed as an aid for developing Appium scripts, not as a replacement for writing/running them. You might get some mileage out of the explanations and quickstarts in the Appium docs, which could help fill in some gaps and get you running an Appium server successfully before using the Inspector.

Agree that there could be more comprehensive docs for the Inspector that don't assume existing knowledge, but that's not something at least I'll be able to do in the foreseeable future.

You could also take an Appium course, many of them introduce the inspector along the way.

@rushian
Copy link
Contributor

rushian commented Sep 30, 2023

I made a post that shows the installation from the cell phone emulator to the script running with robot framework, using appium server 2
https://upqa.wordpress.com/2023/09/29/tutorial-appium-robot-framework-2

@eglitise eglitise added the documentation Improvements or additions to documentation label Jan 28, 2024
@eglitise
Copy link
Collaborator

eglitise commented Feb 1, 2024

Documentation has now been added, and can be accessed at https://appium.github.io/appium-inspector/.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants