OpenAdapt icon indicating copy to clipboard operation
OpenAdapt copied to clipboard

Update Gitbook Getting Started guide with Screenshots

Open abrichr opened this issue 8 months ago • 8 comments

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

  1. Download OpenAdapt
  2. Install OpenAdapt (for now this is just extracting the zip)
  3. Run OpenAdapt
  4. Complete the onboarding (this is almost merged, https://github.com/OpenAdaptAI/OpenAdapt/pull/746)

B: Create a recording

  1. Right-click the tray icon -> Click "Record" -> Type a task description -> Click "OK"
  2. Open some apps, type some letters, move/click/scroll the mouse
  3. Stop the recording by pressing "Ctrl" three times
  4. Wait for it to stop

C: View the recording

  1. Right-click the tray icon -> click "Launch Dashboard" (if it isn't already running)
  2. Click "Recordings"
  3. Click on the recording you just created
  4. Scroll down through the events, removing any accidental/unnecessary actions by clicking "Delete"

D: Scrub the recording (optional)

  1. See "Scrubbing" in dashboard

E: Replay the recording

  1. Right-click the tray icon -> click "Replay" -> Select the recording
  2. Select a replay strategy (leaving the default VisualReplayStrategy is recommended)
  3. Type some text instructions
  4. Click "OK"

F: Upload your recording and replay

  1. Coming soon! (https://github.com/OpenAdaptAI/OpenAdapt/issues/767)

abrichr avatar Jun 17 '24 00:06 abrichr