Skip to content

Commit

Permalink
docs: update docs #none
Browse files Browse the repository at this point in the history
  • Loading branch information
taprosoft committed Sep 23, 2024
1 parent 96f8f87 commit 87f4d0f
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 29 deletions.
32 changes: 3 additions & 29 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,37 +5,11 @@
This page is intended for **end users** who want to use the `kotaemon` tool for Question
Answering on local documents. If you are a **developer** who wants contribute to the project, please visit the [development](development/index.md) page.

## Installation (Online HuggingFace Space)
## Installation (Online HuggingFace Space) - easy (10 mins)

<details>
Visit this [guide](online_install.md).

<summary>View instruction</summary>

1. Go to [kotaemon_template](https://huggingface.co/spaces/cin-model/kotaemon_template)

2. Use Duplicate function to create your own space

![Duplicate space](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/duplicate_space.png)

![Change space params](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/change_space_params.png)

3. Wait for the build to complete and start up (apprx 10 mins).

![Wait space build](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/space_build.png)

![Close space build](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/close_logs_space.png)

4. Follow the first setup instructions (and register for Cohere API key if needed)

![Cohere API](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/cohere_api_key.png)

5. Complete the setup and use your own private space!

![App Startup](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/initial_startup.png)

</details>

## Installation (Offline)
## Installation (Offline) - intermediate (20 mins)

### Download

Expand Down
13 changes: 13 additions & 0 deletions docs/online_install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## Installation (Online HuggingFace Space)

1. Go to [HF kotaemon_template](https://huggingface.co/spaces/cin-model/kotaemon_template).
2. Use Duplicate function to create your own space.
![Duplicate space](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/duplicate_space.png)
![Change space params](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/change_space_params.png)
3. Wait for the build to complete and start up (apprx 10 mins).
![Wait space build](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/space_build.png)
![Close space build](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/close_logs_space.png)
4. Follow the first setup instructions (and register for Cohere API key if needed).
![Cohere API](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/cohere_api_key.png)
5. Complete the setup and use your own private space!
![App Startup](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/initial_startup.png)

0 comments on commit 87f4d0f

Please sign in to comment.