Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add brief user doc with screenshots #61

Merged
merged 4 commits into from
Apr 11, 2024
Merged

Add brief user doc with screenshots #61

merged 4 commits into from
Apr 11, 2024

Conversation

julien-nc
Copy link
Member

Comment on lines 17 to 38
![top right icon](../img/assistant.png)

You task will run immediately if possible or be scheduled for later execution.

![top right icon](../img/getting.results.png)

![top right icon](../img/scheduled.png)

## Notifications

If it is scheduled, you will receive a notification when it has finished.
You can display the task results by clicking the "View results" button in the notification.

![top right icon](../img/notifications.png)

## History

On the bottom left corner of the assistant, there is a button display the task history.
This task history is filtered to only show tasks of the selected task type.
You can then relaunch previous tasks, delete them or just cancel them if they were scheduled.

![top right icon](../img/history.png)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the alt of the images needs an update. lgtm otherwise 🎉

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🙈

@DaphneMuller
Copy link

It looks good to me, please also document how to access the smart pickers

Signed-off-by: Julien Veyssier <[email protected]>

## Notifications

If it is scheduled, you will receive a notification when it has finished.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If it is scheduled, you will receive a notification when it has finished.
If the task was scheduled, you will receive a notification when it has finished.


## History

On the bottom left corner of the assistant, there is a button display the task history.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
On the bottom left corner of the assistant, there is a button display the task history.
On the bottom left corner of the assistant, there is a button to display the task history.

## History

On the bottom left corner of the assistant, there is a button display the task history.
This task history is filtered to only show tasks of the selected task type.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This task history is filtered to only show tasks of the selected task type.
This task history is filtered to only show tasks of the currently selected task type.

Signed-off-by: Julien Veyssier <[email protected]>
@julien-nc
Copy link
Member Author

Thank you all 💙

@julien-nc julien-nc merged commit 1821582 into main Apr 11, 2024
10 checks passed
@delete-merged-branch delete-merged-branch bot deleted the enh/user-doc branch April 11, 2024 10:45
@julien-nc julien-nc mentioned this pull request Apr 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants