Update docs (#49)

docs/development/contributing.md

@@ -1,5 +1,47 @@
 # Contributing
 
+## Setting up
+
+- Clone the repo
+
+  ```shell
+  git clone git@github.com:Cinnamon/kotaemon.git
+  cd kotaemon
+  ```
+
+- Install the environment
+
+  - Create a conda environment (python >= 3.10 is recommended)
+
+    ```shell
+    conda create -n kotaemon python=3.10
+    conda activate kotaemon
+
+    # install dependencies
+    cd libs/kotaemon
+    pip install -e ".[all]"
+    ```
+
+  - Or run the installer (one of the `scripts/run_*` scripts depends on your OS), then
+    you will have all the dependencies installed as a conda environment at
+    `install_dir/env`.
+
+    ```shell
+    conda activate install_dir/env
+    ```
+
+- Pre-commit
+
+  ```shell
+  pre-commit install
+  ```
+
+- Test
+
+  ```shell
+  pytest tests
+  ```
+
 ## Package overview
 
 `kotaemon` library focuses on the AI building blocks to implement a RAG-based QA application. It consists of base interfaces, core components and a list of utilities:

docs/index.md

@@ -1,6 +1,6 @@
 # Getting Started with Kotaemon
 
-![chat demo](images/chat-demo.gif)
+![type:video](https://github.com/Cinnamon/kotaemon/assets/25688648/815ecf68-3a02-4914-a0dd-3f8ec7e75cd9)
 
 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.
@@ -25,9 +25,9 @@ Download and upzip the latest version of `kotaemon` by clicking this
 
 ## Launch
 
-To launch the app after initial setup or any changes, simply run the `run_*` script again.
+To launch the app after initial setup or any change, simply run the `run_*` script again.
 
-A browser window will be opened and greet you with this screen:
+A browser window will be opened and greets you with this screen:
 
 ![Chat tab](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/chat-tab.png)