docs: improve installation instructions (#620) #none

* docs: update instructions * fix: typo in CONTRIBUTING.md (#614) * fix: typo in usage.md (#598) minor typo fix (tt -> it) --------- Co-authored-by: Varun Sharma <[email protected]> Co-authored-by: natowi <[email protected]>
Cinnamon · Jan 13, 2025 · 1c5849c · 1c5849c
1 parent 5343d0d
commit 1c5849c
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 2 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -33,7 +33,7 @@ git checkout -b descriptive-name-for-your-changes
 4. **Setup the development environment**: If you are working on the code, make sure to install the necessary dependencies for development
 
 ```sh
-pip install -e "libs/kotaemon[dev]
+pip install -e "libs/kotaemon[dev]"
 ```
 
 5. **Make your changes**: Ensure your code follows the project's coding style and passes all test cases.

diff --git a/README.md b/README.md
@@ -101,6 +101,7 @@ documents and developers who want to build their own RAG pipeline.
      docker run \
      -e GRADIO_SERVER_NAME=0.0.0.0 \
      -e GRADIO_SERVER_PORT=7860 \
+     -v ./ktem_app_data:/app/ktem_app_data \
      -p 7860:7860 -it --rm \
      ghcr.io/cinnamon/kotaemon:main-lite
      ```
@@ -111,6 +112,7 @@ documents and developers who want to build their own RAG pipeline.
      docker run \
      -e GRADIO_SERVER_NAME=0.0.0.0 \
      -e GRADIO_SERVER_PORT=7860 \
+     -v ./ktem_app_data:/app/ktem_app_data \
      -p 7860:7860 -it --rm \
      ghcr.io/cinnamon/kotaemon:main-full
      ```
@@ -122,6 +124,7 @@ documents and developers who want to build their own RAG pipeline.
    docker run \
    -e GRADIO_SERVER_NAME=0.0.0.0 \
    -e GRADIO_SERVER_PORT=7860 \
+   -v ./ktem_app_data:/app/ktem_app_data \
    -p 7860:7860 -it --rm \
    --platform linux/arm64 \
    ghcr.io/cinnamon/kotaemon:main-lite

diff --git a/docs/index.md b/docs/index.md
@@ -28,6 +28,7 @@ Download the `kotaemon-app.zip` file from the [latest release](https://github.co
    - Linux: `run_linux.sh`. Please run the script using `bash run_linux.sh` in your terminal.
 2. After the installation, the installer will ask to launch the ktem's UI, answer to continue.
 3. If launched, the application will be open automatically in your browser.
+4. Default login information is: `username: admin / password: admin`. You should change this credential right after the first login on the UI.
 
 ## Launch
 

diff --git a/docs/usage.md b/docs/usage.md
@@ -5,7 +5,7 @@
 - The tool uses Large Language Model (LLMs) to perform various tasks in a QA pipeline.
   So, you need to provide the application with access to the LLMs you want
   to use.
-- You only need to provide at least one. However, tt is recommended that you include all the LLMs
+- You only need to provide at least one. However, it is recommended that you include all the LLMs
   that you have access to, you will be able to switch between them while using the
   application.