OpenAdapt
OpenAdapt copied to clipboard
Update Gitbook Getting Started guide with Screenshots
Feature request
We would like to update https://openadapt.gitbook.io/openadapt.ai/getting-started/readme/quick-start with screenshots of the new dashboard + system tray GUI functionality.
This is currently a quick-start for developers. We need a new quick-start for users
Newer functionality is documented at https://github.com/OpenAdaptAI/OpenAdapt#usage, but not for users
This involves:
- going through the download + install + record + replay process, documenting the steps as you go (taking screenshots)
- transferring your documentation to Gitbook via a Pull Request into https://github.com/OpenAdaptAI/OpenAdapt/tree/docs containing text and images (screenshots)
- moving the current "quickstart" section into a legacy page.
The goal of this exercise is to have documentation for users, i.e. people with no command line experience.
I would expect to see the following rough breakdown:
A: Download and install
- Download OpenAdapt
- Install OpenAdapt (for now this is just extracting the zip)
- Run OpenAdapt
- Complete the onboarding (this is almost merged, https://github.com/OpenAdaptAI/OpenAdapt/pull/746)
B: Create a recording
- Right-click the tray icon -> Click "Record" -> Type a task description -> Click "OK"
- Open some apps, type some letters, move/click/scroll the mouse
- Stop the recording by pressing "Ctrl" three times
- Wait for it to stop
C: View the recording
- Right-click the tray icon -> click "Launch Dashboard" (if it isn't already running)
- Click "Recordings"
- Click on the recording you just created
- Scroll down through the events, removing any accidental/unnecessary actions by clicking "Delete"
D: Scrub the recording (optional)
- See "Scrubbing" in dashboard
E: Replay the recording
- Right-click the tray icon -> click "Replay" -> Select the recording
- Select a replay strategy (leaving the default VisualReplayStrategy is recommended)
- Type some text instructions
- Click "OK"
F: Upload your recording and replay
- Coming soon! (https://github.com/OpenAdaptAI/OpenAdapt/issues/767)