Skip to content

Commit 87f4d0f

Browse files
committed
docs: update docs #none
1 parent 96f8f87 commit 87f4d0f

File tree

2 files changed

+16
-29
lines changed

2 files changed

+16
-29
lines changed

docs/index.md

Lines changed: 3 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -5,37 +5,11 @@
55
This page is intended for **end users** who want to use the `kotaemon` tool for Question
66
Answering on local documents. If you are a **developer** who wants contribute to the project, please visit the [development](development/index.md) page.
77

8-
## Installation (Online HuggingFace Space)
8+
## Installation (Online HuggingFace Space) - easy (10 mins)
99

10-
<details>
10+
Visit this [guide](online_install.md).
1111

12-
<summary>View instruction</summary>
13-
14-
1. Go to [kotaemon_template](https://huggingface.co/spaces/cin-model/kotaemon_template)
15-
16-
2. Use Duplicate function to create your own space
17-
18-
![Duplicate space](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/duplicate_space.png)
19-
20-
![Change space params](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/change_space_params.png)
21-
22-
3. Wait for the build to complete and start up (apprx 10 mins).
23-
24-
![Wait space build](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/space_build.png)
25-
26-
![Close space build](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/close_logs_space.png)
27-
28-
4. Follow the first setup instructions (and register for Cohere API key if needed)
29-
30-
![Cohere API](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/cohere_api_key.png)
31-
32-
5. Complete the setup and use your own private space!
33-
34-
![App Startup](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/initial_startup.png)
35-
36-
</details>
37-
38-
## Installation (Offline)
12+
## Installation (Offline) - intermediate (20 mins)
3913

4014
### Download
4115

docs/online_install.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
## Installation (Online HuggingFace Space)
2+
3+
1. Go to [HF kotaemon_template](https://huggingface.co/spaces/cin-model/kotaemon_template).
4+
2. Use Duplicate function to create your own space.
5+
![Duplicate space](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/duplicate_space.png)
6+
![Change space params](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/change_space_params.png)
7+
3. Wait for the build to complete and start up (apprx 10 mins).
8+
![Wait space build](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/space_build.png)
9+
![Close space build](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/close_logs_space.png)
10+
4. Follow the first setup instructions (and register for Cohere API key if needed).
11+
![Cohere API](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/cohere_api_key.png)
12+
5. Complete the setup and use your own private space!
13+
![App Startup](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/initial_startup.png)

0 commit comments

Comments
 (0)