Merge pull request #61 from nextcloud/enh/user-doc

Add brief user doc with screenshots

README.md

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

appinfo/info.xml

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

docs/README.md

@@ -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)

docs/developer/README.md

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

docs/ocs-api.md → docs/developer/ocs-api.md

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

docs/user/README.md

@@ -0,0 +1,58 @@
+# 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.
+
+## Assistant
+
+### 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.
+
+![assistant](../img/assistant.png)
+
+You task will run immediately if possible or be scheduled for later execution.
+
+![getting results](../img/getting.results.png)
+
+![scheduled](../img/scheduled.png)
+
+### Notifications
+
+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.
+
+![notifications](../img/notifications.png)
+
+### 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 currently selected task type.
+You can then relaunch previous tasks, delete them or just cancel them if they were scheduled.
+
+![task history](../img/history.png)
+
+## Smart picker
+
+The assistant app provides 3 smart pickers that you can access in Talk,
+Text and in every place where rich text edition is possible.
+To use them, type "/" and then "ai". They will appear in the filtered provider list.
+
+In Talk:
+![smart picker in talk](../img/smart.picker.talk.png)
+In Text:
+![smart picker in text](../img/smart.picker.in.text.png)
+
+The pickers:
+![smart picker image generation](../img/smart.picker.image.png)
+![smart picker audio transcription](../img/smart.picker.audio.png)
+![smart picker text generation](../img/smart.picker.text.png)
+
+If possible, the picker result will be directly inserted in the current context.