Update Gitbook Getting Started guide with Screenshots

[abrichr]

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, Add onboarding for new users #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! (Upload recordings #767)

[abrichr]

/bounty $100

[algora-pbc]

💎 $100 bounty • OpenAdaptAI

Steps to solve:

1. Start working: Comment /attempt #764 with your implementation plan
2. Submit work: Create a pull request including /claim #764 in the PR body to claim the bounty
3. Receive payment: 100% of the bounty is received 2-5 days post-reward. Make sure you are eligible for payouts

Thank you for contributing to OpenAdaptAI/OpenAdapt!

Attempt	Started (UTC)	Solution	Actions
🟢 @Omar8345	Apr 13, 2025, 05:38:22 AM	WIP
🟢 @onyedikachi-david	Jun 17, 2024, 07:40:37 AM	WIP
🟢 @shashank40	Jun 17, 2024, 12:14:54 PM	#771	Reward

[onyedikachi-david]

/attempt #764

Algora profile	Completed bounties	Tech	Active attempts	Options
@onyedikachi-david	2 bounties from 1 project	JavaScript, Shell		Cancel attempt

[shashank40]

/attempt #764

Algora profile	Completed bounties	Tech	Active attempts	Options
@shashank40	2 bounties from 2 projects	Python, TypeScript, JavaScript		Cancel attempt

[shashank40]

@abrichr Just a quick question, when you say screenshots, would you prefer the ones on GitHub developer documentation? Or should we add new screenshots?

[abrichr]

Thank you @shashank40! This involves taking new screenshots

[algora-pbc]

💡 @shashank40 submitted a pull request that claims the bounty. You can visit your bounty board to reward.