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
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ This app brings a user interface to use the Nextcloud text processing feature.
It allows users to launch AI tasks, be notified when they finish and see the results.
The assistant also appears in others apps like Text to easily process parts of a document.

More details on the assistant OCS API and frontend integration possibilities in the
[developer doc](https://github.com/nextcloud/assistant/raw/main/docs/developer)

### How to use it

A new right header menu entry appears. Once clicked, the assistant is displayed and you can select and task type and
Expand All @@ -18,6 +21,8 @@ Other apps can integrate with the assistant. For example, Text will display an i
to directly select a task type to process this paragraph. Selecting a task this way will open the assistant with the task
being pre-selected and the input text set.

More details and screenshots in the [user doc](https://github.com/nextcloud/assistant/raw/main/docs/user).

## Features

In the assistant, the list of available tasks depends on the available providers installed via other apps.
Expand Down
5 changes: 5 additions & 0 deletions appinfo/info.xml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ This app brings a user interface to use the Nextcloud text processing feature.
It allows users to launch AI tasks, be notified when they finish and see the results.
The assistant also appears in others apps like Text to easily process parts of a document.

More details on the assistant OCS API and frontend integration possibilities in the
[developer doc](https://github.com/nextcloud/assistant/raw/main/docs/developer)

### How to use it

A new right header menu entry appears. Once clicked, the assistant is displayed and you can select and task type and
Expand All @@ -22,6 +25,8 @@ Other apps can integrate with the assistant. For example, Text will display an i
to directly select a task type to process this paragraph. Selecting a task this way will open the assistant with the task
being pre-selected and the input text set.

More details and screenshots in the [user doc](https://github.com/nextcloud/assistant/raw/main/docs/user).

## Features

In the assistant, the list of available tasks depends on the available providers installed via other apps.
Expand Down
8 changes: 4 additions & 4 deletions docs/README.md
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)
5 changes: 5 additions & 0 deletions docs/developer/README.md
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.

4 changes: 2 additions & 2 deletions docs/ocs-api.md → docs/developer/ocs-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ This API is documented with OpenAPI. You can view it with the [ocs_api_viewer ap
* browse the ocs_api_viewer app
* select "assistant" in the left sidebar

For the moment we have different endpoints for Text Processing, Speech to text and Image generation. This will be unified
in the near future.
For the moment we have different endpoints for Text Processing, Speech to text and Image generation.
This will be unified in the near future so there might be breaking changes to this API.
File renamed without changes.
Binary file added docs/img/assistant.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/getting.results.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/history.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/notifications.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/scheduled.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/img/top.right.button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
38 changes: 38 additions & 0 deletions docs/user/README.md
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.
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.

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.
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.

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.

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.

🙈

Loading