Update: Gitbook user guide. Issue #764 #771

shashank40 · 2024-06-18T10:03:46Z

/claim #764

What kind of change does this PR introduce?

Gitbook User Documentation Update

Summary

As the user guide on Gitbook was old & new features were added to OpenAdapt. The documentation needed a rework with images.

Checklist

My code follows the style guidelines of OpenAdapt
I have performed a self-review of my code
If applicable, I have added tests to prove my fix is functional/effective
I have linted my code locally prior to submission
I have commented my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation (e.g. README.md, requirements.txt)
New and existing unit tests pass locally with my changes

How can your code be run and tested?

Other information

shashank40 · 2024-06-18T10:07:17Z

Hi @abrichr.
I have added all the required updates to run OpenAdapt with necessary screenshots from my local.

Will be waiting for your review.

Also i found a lot of code issues while running OpenAdapt locally. There were many errors in code which needed to be fixed to run it locally. Some of these bugs were introduced last week.

Should i create a new issue and raise a PR?

abrichr · 2024-06-18T13:16:31Z

@shashank40 thank you! Please do 🙏

abrichr · 2024-06-18T13:18:37Z

Upon review it appears that you simply copied the screenshots from the README.

From the Issue Description:

screenshots of the new dashboard + system tray GUI functionality.

This involves:

going through the download + install + record + replay process, documenting the steps as you go (taking screenshots).

abrichr

Please remove all of the old screenshots and take new ones.

shashank40 · 2024-06-18T13:34:21Z

No @abrichr
The only 4 screenshots taken from README are the feature images.
Rest 11 images are screenshots from my mac.

Also there is a reason for feature images to be picked from README as there is not much difference from current photos.

But i will update those 4 with new ones

abrichr · 2024-06-18T13:51:57Z

getting-started/welcome-to-openadapt/quick-start.md

 {% hint style="info" %}
 **Good to know:** After installing OpenAdapt, run\
 `pytest` to verify that the installation was successful.
 {% endhint %}

-## Make your first recording
+## Usage


Please move this to a new section titled something like "Developer Usage".

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

Hi @abrichr
For me downloading the app and installing gets stuck in terminal here(and i tried this multiple times). And there is no prompt that comes up

For me command line worked best with start command

Is there a better way to start the app? Because i gave all the necessary Mac permissions needed for it.

Hi @shashank40 , sorry to hear that, thank you for letting us know. Can you please provide the full console output? @KIRA009 any suggestions would be appreciated 🙏

@abrichr sadly is the full console output 😅.
The terminal gets stuck after it prints the last key(DEFAULT_ADAPTER)

Can you please provide the exact command (or ideally sequence of commands) you ran in order to arrive at this error? The full console output would be very helpful.

@KIRA009 not working for me

Thanks @shashank40 I have attached a video of me running the latest version. You can see that a tray icon appears on the top bar

https://www.loom.com/share/af29afa9500e4085b8587d377aa8c91e?sid=e3eaa4a6-fe70-408d-b858-b0dba4a9ca59

Working fine for me now. I was able to debug it.

So basically we might need to update the permission section for latest macOS.

It needs to get screen-recording permission for OpenAdapter app as well.

Works fine for me now. Just need to get the latest MAC build, that might get updated in sometime if this PR
#776 is approved and ready to get merged

That is great. I assumed you had all the necessary permissions from your comment #771 (comment), but you are right, this definitely needs better documentation.

Thank you @shashank40 ! Tracked in #778

unwanted commit Added client removed file Removed old images

shashank40 · 2024-06-18T21:05:21Z

@abrichr Now i have added a detailed user guide separately as well.
The documentation will now have developer guide and user guide separately.

Removed unwanted photo Removed unwanted photo

shashank40 · 2024-06-19T16:25:59Z

Hey @abrichr would like to get an update on this documentation as well.

According to me this is now complete for both Users and Developers

abrichr · 2024-06-20T12:30:43Z

Hi @shashank40 , thank you for your patience. I am in touch with Gitbook support in order to enable previews on pull requests from forks. Will get back to you ASAP.

abrichr · 2024-06-29T14:41:11Z

Hi @shashank40 , here is an excerpt from an email thread with Gitbook support:

If I click on "Details" on either of the checks:

I see this revision:

If I click on the link to https://github.com/OpenAdaptAI/OpenAdapt/blob/docs/getting-started/welcome-to-openadapt/user-guide.md, I see a 404:

--

It seems that the files that are being referenced here are also being created in this PR. Which means that they are not yet referenced in the SUMMARY.md file for your docs.

The SUMMARY.md file is the source of truth for your docs, it's the file we use to build the table of contents for your documentation. Since it doesn't have a reference for those two files user-guide.md and developer-guide.md it goes to GitHub and GitHub returns a not found, since the file doesn't exist in the repo yet, it's still in the PR.

So for the link to work, the files have to be added to the SUMMARY.md file in the same PR. That way we'll create a revision where the links will be functional.

@shashank40 I would love to review this but in its current state I am unable to. Can you please make sure this works on Gitbook? I believe you should be able to click through the preview links.

shashank40 · 2024-06-29T15:15:47Z

@abrichr can i have the permission to create preview links on my PR?
I cannot debug it without that.

Also the docs branch doesn't have this new code yet so you wont be able to test it on docs branch.

abrichr · 2024-06-30T13:59:02Z

@shashank40 I don't believe you need any special permissions.

Click "Show all checks":

Then click on "Details" to view the content live on gitbook.io.

Also the docs branch doesn't have this new code yet so you wont be able to test it on docs branch.

I'm just clicking on the "Details" link like I described above.

abrichr · 2024-06-30T14:00:11Z

From Gitbook support:

It seems that the files that are being referenced here are also being created in this PR. Which means that they are not yet referenced in the SUMMARY.md file for your docs.

The SUMMARY.md file is the source of truth for your docs, it's the file we use to build the table of contents for your documentation. Since it doesn't have a reference for those two files user-guide.md and developer-guide.md it goes to GitHub and GitHub returns a not found, since the file doesn't exist in the repo yet, it's still in the PR.

So for the link to work, the files have to be added to the SUMMARY.md file in the same PR. That way we'll create a revision where the links will be functional.

shashank40 · 2024-06-30T14:02:56Z

Yess now i can see the gitbook link.
Thanks, Will add it

test commit for image size test commit for image size test commit for image size test commit for image size test commit for image size

algora-pbc bot mentioned this pull request Jun 18, 2024

Update Gitbook Getting Started guide with Screenshots #764

Open

algora-pbc bot added the 🙋 Bounty claim label Jun 18, 2024

shashank40 force-pushed the update/gitbook-getting-started-guide/764 branch from d0c015c to b5b0360 Compare June 18, 2024 11:09

abrichr requested changes Jun 18, 2024

View reviewed changes

abrichr reviewed Jun 18, 2024

View reviewed changes

Update: Gitbook user guide. Issue OpenAdaptAI#764

af6136c

unwanted commit Added client removed file Removed old images

shashank40 force-pushed the update/gitbook-getting-started-guide/764 branch from b5b0360 to af6136c Compare June 18, 2024 14:00

This was referenced Jun 18, 2024

[Bug]: Local development record, replay and start fail #773

Open

Fix : Local development failing due to changed function definition #776

Closed

abrichr mentioned this pull request Jun 18, 2024

Document permissions on latest MacOS #778

Open

shashank40 requested a review from abrichr June 18, 2024 21:05

shashank40 force-pushed the update/gitbook-getting-started-guide/764 branch from 792fd39 to 0b3e8b5 Compare June 18, 2024 21:07

Added user guide section

3495078

Removed unwanted photo Removed unwanted photo

shashank40 force-pushed the update/gitbook-getting-started-guide/764 branch from 0b3e8b5 to 3495078 Compare June 18, 2024 21:09

shashank40 mentioned this pull request Jun 19, 2024

Fix incorrect argument when visualizing from tray #780

Merged

7 tasks

Added reference to Summary.md

2cf9972

shashank40 force-pushed the update/gitbook-getting-started-guide/764 branch 2 times, most recently from 5b29407 to e46969a Compare July 1, 2024 17:05

shashank40 force-pushed the update/gitbook-getting-started-guide/764 branch 2 times, most recently from f7ee931 to 36ecf25 Compare July 1, 2024 18:33

test commit for image size

cc3660e

test commit for image size test commit for image size test commit for image size test commit for image size test commit for image size

shashank40 force-pushed the update/gitbook-getting-started-guide/764 branch from 36ecf25 to cc3660e Compare July 1, 2024 18:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update: Gitbook user guide. Issue #764 #771

Update: Gitbook user guide. Issue #764 #771

shashank40 commented Jun 18, 2024 •

edited

Loading

shashank40 commented Jun 18, 2024

abrichr commented Jun 18, 2024

abrichr commented Jun 18, 2024

abrichr left a comment

shashank40 commented Jun 18, 2024 •

edited

Loading

abrichr Jun 18, 2024 •

edited

Loading

shashank40 Jun 18, 2024

abrichr Jun 18, 2024

shashank40 Jun 18, 2024

abrichr Jun 18, 2024 •

edited

Loading

shashank40 Jun 18, 2024

KIRA009 Jun 18, 2024

shashank40 Jun 18, 2024

KIRA009 Jun 18, 2024

abrichr Jun 18, 2024

shashank40 commented Jun 18, 2024

shashank40 commented Jun 19, 2024

abrichr commented Jun 20, 2024

abrichr commented Jun 29, 2024 •

edited

Loading

shashank40 commented Jun 29, 2024 •

edited

Loading

abrichr commented Jun 30, 2024

abrichr commented Jun 30, 2024

shashank40 commented Jun 30, 2024

Update: Gitbook user guide. Issue #764 #771

Are you sure you want to change the base?

Update: Gitbook user guide. Issue #764 #771

Conversation

shashank40 commented Jun 18, 2024 • edited Loading

shashank40 commented Jun 18, 2024

abrichr commented Jun 18, 2024

abrichr commented Jun 18, 2024

abrichr left a comment

Choose a reason for hiding this comment

shashank40 commented Jun 18, 2024 • edited Loading

abrichr Jun 18, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

abrichr Jun 18, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shashank40 commented Jun 18, 2024

shashank40 commented Jun 19, 2024

abrichr commented Jun 20, 2024

abrichr commented Jun 29, 2024 • edited Loading

shashank40 commented Jun 29, 2024 • edited Loading

abrichr commented Jun 30, 2024

abrichr commented Jun 30, 2024

shashank40 commented Jun 30, 2024

shashank40 commented Jun 18, 2024 •

edited

Loading

shashank40 commented Jun 18, 2024 •

edited

Loading

abrichr Jun 18, 2024 •

edited

Loading

abrichr Jun 18, 2024 •

edited

Loading

abrichr commented Jun 29, 2024 •

edited

Loading

shashank40 commented Jun 29, 2024 •

edited

Loading