Update various docs (#4)

* rename cli tool

* remove redundant docs

* update docs

* update macos instructions

* add badges
This commit is contained in:
ian_Cin
2024-03-29 19:47:03 +07:00
committed by GitHub
parent 556c48b259
commit a3bf728400
23 changed files with 339 additions and 415 deletions

59
docs/usage.md Normal file
View File

@@ -0,0 +1,59 @@
# Basic Usage
## Chat tab
![chat tab](images/chat-tab.png)
The chat tab is divided into 3 columns:
- Left: Conversation settings
- Middle: Chat interface
- Right: Information panel
### Conversation settings
#### Conversation control
Create, rename, and delete conversations.
![covnerstaion control](images/converstaion-control.png)
#### File index
Choose which files to retrieve references from. If no file is selected, all files will be used.
![file index](images/file-index.png)
### Chat interface
Interact with the chatbot.
![chat interface](images/chat-interface.png)
### Information panel
Supporting information such as the retrieved evidence and reference will be displayed
here.
![info panel](images/info-panel.png)
## File index tab
![file index tab](images/file-index-tab.png)
### File upload
In order for a file to be used as an index for retrieval, it must be processed by the
application first. Do this uploading your file to the UI and then select `Upload and Index`.
![file upload](images/file-upload.png)
The application will take some time to process the file and show a message once it is
done. Then you will be able to select it in the [File index section](#file-index) of the [Chat tab](#chat-tab).
### File list
This section shows the list of files that have been uploaded to the application and
allows users to delete them.
![file-list](images/file-list.png)