diff --git a/docs/images/change_space_params.png b/docs/images/change_space_params.png new file mode 100644 index 0000000..b5030ac Binary files /dev/null and b/docs/images/change_space_params.png differ diff --git a/docs/images/close_logs_space.png b/docs/images/close_logs_space.png new file mode 100644 index 0000000..82026f7 Binary files /dev/null and b/docs/images/close_logs_space.png differ diff --git a/docs/images/cohere_api_key.png b/docs/images/cohere_api_key.png new file mode 100644 index 0000000..c0ab83c Binary files /dev/null and b/docs/images/cohere_api_key.png differ diff --git a/docs/images/duplicate_space.png b/docs/images/duplicate_space.png new file mode 100644 index 0000000..9297ede Binary files /dev/null and b/docs/images/duplicate_space.png differ diff --git a/docs/images/initial_startup.png b/docs/images/initial_startup.png new file mode 100644 index 0000000..4f0691b Binary files /dev/null and b/docs/images/initial_startup.png differ diff --git a/docs/images/set_api_key_space.png b/docs/images/set_api_key_space.png new file mode 100644 index 0000000..9e4a5bc Binary files /dev/null and b/docs/images/set_api_key_space.png differ diff --git a/docs/images/space_build.png b/docs/images/space_build.png new file mode 100644 index 0000000..c05082d Binary files /dev/null and b/docs/images/space_build.png differ diff --git a/docs/index.md b/docs/index.md index 0e8b2fb..9cef5cf 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,11 +5,43 @@ 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. -## Download +## Installation (Online HuggingFace Space) + +
+ +View instruction + +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) + +
+ +## Installation (Offline) + +### Download Download the `kotaemon-app.zip` file from the [latest release](https://github.com/Cinnamon/kotaemon/releases/latest/). -## Installation +### Run setup script 0. Unzip the downloaded file. 1. Navigate to the `scripts` folder and start an installer that matches your OS: