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 #85

Closed
wants to merge 1 commit into from
Closed

Create better documentation #85

wants to merge 1 commit into from

Conversation

yungd1plomat
Copy link
Member

@yungd1plomat yungd1plomat commented Nov 17, 2023

Sections:

  • About
    • Introduction
    • Consulting and Support
    • Licence
  • Getting started
    • Installation
    • Connecting to device
    • Working with lib
  • Reference
    • Screen automation
      • Find elements
      • Click on an element
      • Swipe
      • Type text
      • Send key events
      • Dump xml hierarchy
      • Create screenshots
    • Device commands
      • Install applications
      • Starting applications
      • Working with 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 docs

Or using any other http servers. Example with python:

cd docs && python -m SimpleHTTPServer 3000

# OR

cd docs && python -m http.server 3000

@wherewhere
Copy link
Member

It will be better to have a new repo to write doc.
And repo wiki is here...
https://github.com/SharpAdb/AdvancedSharpAdbClient/wiki

@yungd1plomat
Copy link
Member Author

It will be better to have a new repo to write doc. And repo wiki is here... https://github.com/SharpAdb/AdvancedSharpAdbClient/wiki

i thinks it's ok to have docs here because github pages domain will be AdvancedSharpAdbClient.github.io

@wherewhere
Copy link
Member

It is better to not use var in document. Using var will make it unclearly.

@wherewhere
Copy link
Member

wherewhere commented Nov 17, 2023

i thinks it's ok to have docs here because github pages domain will be AdvancedSharpAdbClient.github.io

SharpAdb.Documents.github.io
It can contains all documents under SharpAdb Project. Like .NET Community.

@yungd1plomat
Copy link
Member Author

ok i'll move later

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

We need a better documentation for the library
2 participants