Added user guide section

Removed unwanted photo

README.md

@@ -11,12 +11,20 @@ description: >-
 
 Welcome to OpenAdapt's developer API! Here you'll find all the documentation you need to get up and running with our software.
 
-## Want to jump right in?
+## Want to jump to user guide?
 
-Get started on installing OpenAdapt by following our [quick-start.md](getting-started/welcome-to-openadapt/quick-start.md "mention")
+Get started on installing OpenAdapt by following our [user-guide.md](getting-started/welcome-to-openadapt/user-guide.md "mention")
 
-{% content-ref url="getting-started/welcome-to-openadapt/quick-start.md" %}
-[quick-start.md](getting-started/welcome-to-openadapt/quick-start.md)
+{% content-ref url="getting-started/welcome-to-openadapt/user-guide.md" %}
+[user-guide.md](getting-started/welcome-to-openadapt/user-guide.md)
+{% endcontent-ref %}
+
+## Want to jump to developer guide?
+
+Get started with testing/development with OpenAdapt by following our [developer-guide.md](getting-started/welcome-to-openadapt/developer-guide.md "mention")
+
+{% content-ref url="getting-started/welcome-to-openadapt/developer-guide.md" %}
+[developer-guide.md](getting-started/welcome-to-openadapt/developer-guide.md)
 {% endcontent-ref %}
 
 ## Already Familiar?

getting-started/welcome-to-openadapt/quick-start.md → getting-started/welcome-to-openadapt/developer-guide.md

@@ -2,7 +2,7 @@
 description: Working with OpenAdapt
 ---
 
-# Quick Start
+# Developer Guide
 
 {% hint style="info" %}
 **Experiencing difficulty? Get support on our** [**Discord**](https://discord.gg/QKPuDqhDHF)**.**
@@ -110,6 +110,17 @@ Notice the environment prefix `(openadapt-py3.10)`.
 
 ![image](./assets/poetry-shell.png)
 
+# Run app locally for testing
+
+`python -m openadapt.entrypoint`
+
+CLI would look something like this after the command
+![image](./assets/developer-run-local.png)
+
+After it runs successfully, you will see an app tray at top right of screen
+
+![image](./assets/app-tray.png)
+
 # Make your first recording
 
 {% hint style="info" %}
@@ -210,18 +221,6 @@ See [strategy list](https://github.com/OpenAdaptAI/OpenAdapt/tree/main/openadapt
 
 ![image](./assets/client.png)
 
-# State-of-the-art GUI understanding via [Segment Anything in High Quality](https://github.com/SysCV/sam-hq):
-
-![image](./assets/segment-anything.png)
-
-# Industry leading privacy (PII/PHI scrubbing) via [AWS Comprehend](https://aws.amazon.com/comprehend/), [Microsoft Presidio](https://microsoft.github.io/presidio/) and [Private AI](https://www.private-ai.com/en/redact/):
-
-![image](./assets/privacy.png)
-
-# Decentralized and secure data distribution via [Magic Wormhole](https://github.com/magic-wormhole/magic-wormhole):
-
-![image](./assets/secure-data-distribution.png)
-
 # Detailed performance monitoring via [pympler](https://pympler.readthedocs.io/en/latest/) and [tracemalloc](https://docs.python.org/3/library/tracemalloc.html):
 
 ![image](./assets/visualize-3.png)

getting-started/welcome-to-openadapt/user-guide.md

@@ -0,0 +1,105 @@
+---
+description: Installing OpenAdapt
+---
+
+# User Guide
+
+{% hint style="info" %}
+**Experiencing difficulty? Get support on our** [**Discord**](https://discord.gg/QKPuDqhDHF)**.**
+{% endhint %}
+
+OpenAdapt **requires Python3.10**, you can download it [here](https://www.python.org/downloads/) or try our installer, which will download Python for you. 
+
+
+## Download OpenAdapt
+
+We have builds available for Windows and Mac
+
+{% hint style="info" %}
+**IMPORTANT:** If you are on MAC, give these [permissions](https://github.com/OpenAdaptAI/OpenAdapt/blob/main/permissions_in_macOS.md)
+{% endhint %}
+
+- Download the OpenAdapt application from [here](https://openadapt.ai/#start)
+![image](./assets/download-page.png)
+- Extract the zip
+![image](./assets/downloaded-zip.png)
+- Click on the extracted application
+- It creates an app-tray on top right. This app tray can be used to control the application.
+![image](./assets/app-tray.png)
+
+
+## Start Recording
+
+Now after the application is installed, you can start recording following the steps explained.
+
+- Click the record button in the app-tray
+- It opens up a prompt to name your recording
+![image](./assets/record-prompt.png)
+- Give it a name and click ok. Now the recording starts.
+
+
+## Stop Recording
+
+To end the recording you can simply
+
+- Click the stop recording button in the app-tray and the recording is saved.
+![image](./assets/stop-recording.png)
+
+
+## Replay Recording
+
+To replay the saved recordings
+
+- Click on replay in the app-tray. It opens list of all the recordings.
+![image](./assets/replay-list.png)
+- Click on the recording you want to replay. This will open up a prompt to choose the **replay strategy** & **replay instructions**
+
+![image](./assets/replay-strategy-prompt.png)
+
+{% hint style="info" %}
+**Good to know:** Read more about strategies [here](./developer-guide.md/#playback)
+{% endhint %}
+
+- Here is a quick [demo](https://openadapt.ai/#demo-video) of how to use replay strategy & instructions.
+
+
+## Visualize Recording
+
+You can visualize data about your recording events too.
+
+- Click on visualize in the app-tray
+- Choose the recording you want to visualize
+![image](./assets/visualize-list.png)
+- It opens an HTML page with extensive details about the events in your recordings
+![image](./assets/visualize-userapp-1.png)
+
+
+## Delete Recording
+
+If you want to delete any recording from OpenAdapt, you can do it easily.
+
+- Click on delete button in app-tray
+- A list of available recordings appear
+- Choose the recording to delete
+
+
+## Dashboard
+
+You can now control OpenAdapt from the GUI recently introduced. You can easily see all the **recordings**, **get recording data**, **change setting such as API keys**, choose to **scrubb a recording**, **replays** etc
+
+- Click on dashboard in the app-tray
+- A GUI opens on your browser similar to this
+![image](./assets/dashboard.png)
+- On settings page you can change API keys, turn on scrub etc
+![image](./assets/dashboard-settings.png)
+
+
+# Scrubbing
+
+You can now scrub a recording of your choice and it gets processed.
+
+- In the dashboard settings, turn on scrubbing.
+- Navigate to scrubbing and choose a recording to scrub. Choose the provider
+- Now wait for the recording to be processed
+![image](./assets/scrubbing-processing.png) 
+