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

Create better documentation #1

Merged
merged 6 commits into from
Jun 30, 2024
Merged

Create better documentation #1

merged 6 commits into from
Jun 30, 2024

Conversation

yungd1plomat
Copy link
Member

@yungd1plomat yungd1plomat commented Nov 20, 2023

Sections:

  • About
    • Introduction
    • Consulting and Support
    • Licence
  • Getting started
    • Installation
    • Connecting to device
    • Working with lib
  • Reference
    • Screen automation
      • Overview screen elements
      • Find elements
      • Click on an element
      • Swipe
      • Type text
      • Send key events
      • Create screenshots
    • Device commands
      • Install and uninstall applications
      • Start and stop applications
      • Push and pull files
      • Run shell commands
      • Forward connection
  • Tutorials
    • Automate multiple Nox emulators

Docs created using docsify and docsify-darklight-theme

To serve docs use docsify http server

# Install docsify
npm i docsify-cli -g

# Serve docs
docsify serve .

Or using any other http servers. Example with python:

python -m SimpleHTTPServer 3000

# OR

python -m http.server 3000

@wherewhere
Copy link
Member

How can I use Github Package? It said Your request could not be authenticated by the GitHub Packages service. Please ensure your access token is valid and has the appropriate scopes configured. when I use my personal token.

@yungd1plomat
Copy link
Member Author

yungd1plomat commented Nov 23, 2023

How can I use Github Package? It said Your request could not be authenticated by the GitHub Packages service. Please ensure your access token is valid and has the appropriate scopes configured. when I use my personal token.

Do you have telegram?

P.S. you can use GITHUB_TOKEN

@wherewhere
Copy link
Member

wherewhere/wherewhere7

@wherewhere
Copy link
Member

Long time no see. 😜

@yungd1plomat
Copy link
Member Author

U can preview here https://sharpadb.github.io (I'll change the branch for gh pages after merge)

@yungd1plomat yungd1plomat merged commit 8d73ecd into master Jun 30, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

We need a better documentation for the library
2 participants