-
Notifications
You must be signed in to change notification settings - Fork 6
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
Changes from 2 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
# Assistant developer doc | ||
|
||
This documentation is about [integrating the assistant](./web-integration.md) in the frontend of other Nextcloud applications | ||
and about using the [OCS API](./ocs-api.md) to support assistant features in your application or client. | ||
# Assistant docs | ||
|
||
* [User documentation](./user) | ||
* [Developer documentation](./developer) | ||
* [AI admin doc](https://docs.nextcloud.com/server/latest/admin_manual/ai/index.html) |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
# Assistant developer doc | ||
|
||
This documentation is about [integrating the assistant](./web-integration.md) in the frontend of other Nextcloud applications | ||
and about using the [OCS API](./ocs-api.md) to support assistant features in your application or client. | ||
|
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,38 @@ | ||||||
# User documentation | ||||||
|
||||||
## Personal settings | ||||||
|
||||||
The Assistant personal settings can be found under the "Artificial intelligence" section. | ||||||
You can disable the assistant top menu entry there. You can also disable the AI-related smart pickers. | ||||||
|
||||||
## Run a task | ||||||
|
||||||
To run a task with the Assistant, just open it via the top menu entry (on the top right). | ||||||
|
||||||
![top right icon](../img/top.right.button.png) | ||||||
|
||||||
Then choose a task type at the top of the assistant. | ||||||
Then fill up the input form and press the submit button at the bottom right. | ||||||
|
||||||
![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. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
You can then relaunch previous tasks, delete them or just cancel them if they were scheduled. | ||||||
|
||||||
![top right icon](../img/history.png) | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. the alt of the images needs an update. lgtm otherwise 🎉 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🙈 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.