SharpAdb / AdvancedSharpAdbClient

AdvancedSharpAdbClient is a .NET library that allows .NET, Mono and Unity applications to communicate with Android devices. It's improved version of SharpAdbClient.
https://sharpadb.github.io
Apache License 2.0
203 stars 54 forks source link

Create better documentation #85

Closed yungd1plomat closed 1 year ago

yungd1plomat commented 1 year ago

Sections:

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 commented 1 year ago

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

yungd1plomat commented 1 year ago

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 commented 1 year ago

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

wherewhere commented 1 year ago

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 commented 1 year ago

ok i'll move later