docs: add MkDocs documentation #1312
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
eglitise
added
documentation
| 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.
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.
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.
laib3
pushed a commit
to laib3/appium-inspector
that referenced
this pull request
Nov 16, 2024
* docs: create skeleton for MkDocs * docs: add index and troubleshooting pages * docs: add info on XCUI+RN source tree issue * docs: add overview * docs: use inspector icon everywhere * docs: add CI job * docs: add quickstart intro and requirements * docs: add quickstart installation guide * docs: finish quickstart * docs: misc adjustments * docs: use higher resolution icon * docs: add contributing page * docs: fix homepage * fix: adjust tsconfig to silence errors * docs: start session builder, add server details * further group images into folders * docs: fix more image links * docs: add capability builder page * docs: add saved caps sets and attach to session * docs: augment quickstart with more links * docs: add site to gitignore * docs: add links in quickstart intro * docs: tune attach to session * docs: add session inspector intro * docs: WIP header buttons * docs: tune session builder some more * docs: finish header page * docs: WIP screenshot panel * docs: finish screenshot panel * docs: WIP source tab * docs: add more info on group element handles * docs: finish source tab * docs: add commands tab * docs: WIP gestures tab * docs: tune some documents * docs: finish gestures tab * docs: fix link to session inspector * docs: add recorder tab * docs: add session info tab * docs: tune everything * docs: fix image size in README * docs: fix branch name for edit button * docs: run Prettier * docs: add note for nested objects in caps
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.