Update documentations (#23)

docs/development/contributing.md

@@ -9,13 +9,13 @@
   like Langchain, llama-index,... when possible) commonly used components in
   kotaemon use cases. Some of these components are: LLM, vector store,
   document store, retriever... For a detailed list and description of these
-  components, please refer to the [API Reference](/reference/nav/) section.
+  components, please refer to the [API Reference](../reference/Summary.md) section.
 - List of utilities: `kotaemon` provides utilities and tools that are
   usually needed in client project. For example, it provides a prompt
   engineering UI for AI developers in a project to quickly create a prompt
   engineering tool for DMs and QALs. It also provides a command to quickly spin
   up a project code base. For a full list and description of these utilities,
-  please refer to the [Utilities](/development/utilities) section.
+  please refer to the [Utilities](utilities.md) section.
 
 ```mermaid
 mindmap

docs/index.md

@@ -1,6 +1,8 @@
 # Getting Started with Kotaemon
 
-This page is intended for end users who want to use the `kotaemon` tool for Question Answering on local documents.
+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
 
@@ -31,9 +33,9 @@ A browser window will be opened and greet you with this screen:
 
 ## Usage
 
-For how to use the application, see [Usage](/usage). This page will also be available to
+For how to use the application, see [Usage](usage.md). This page will also be available to
 you within the application.
 
 ## Feedback
 
-Feel free to create a bug report or a feature request or join a discussion at https://github.com/Cinnamon/kotaemon/issues.
+Feel free to create a bug report or a feature request on our [repo](https://github.com/Cinnamon/kotaemon/issues).

docs/scripts/generate_reference_docs.py

@@ -68,7 +68,7 @@ def generate_docs_for_src_code(
             full_doc_path, Path("..") / path.relative_to(code_dir.parent)
         )
 
-    with mkdocs_gen_files.open(f"{target_doc_folder}/NAV.md", "w") as nav_file:
+    with mkdocs_gen_files.open(f"{target_doc_folder}/Summary.md", "w") as nav_file:
         nav_file.writelines(nav.build_literate_nav())
 
 

docs/usage.md

@@ -14,18 +14,19 @@
 To add a model:
 
 1. Navigate to the `Resources` tab.
-2. Select `LLM Management`.
-3. Select `Add`.
+2. Select the `LLMs` sub-tab.
+3. Select the `Add` sub-tab.
 4. Config the model to add:
    - Give it a name.
    - Pick a vendor/provider (e.g. `ChatOpenAI`).
    - Provide the specifications.
-   - Optionally, set the model as default.
-5. Click `Add LLM`.
+   - (Optional) Set the model as default.
+5. Click `Add` to add the model.
+6. Select `Embedding Models` sub-tab and repeat the step 3 to 5 to add an embedding model.
 
-<details close>
+<details markdown>
 
-<summary>Configures model via the .env file</summary>
+<summary>(Optional) Configure model via the .env file</summary>
 
 Alternatively, you can configure the models via the `.env` file with the information needed to connect to the LLMs. This file is located in
 the folder of the application. If you don't see it, you can create one.
@@ -104,7 +105,7 @@ Here is how to get the full path of your model file:
 - On Windows 11: right click the file and select `Copy as Path`.
 </details>
 
-## Upload your documents
+## 2. Upload your documents
 
 ![file index tab](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/file-index-tab.png)
 
@@ -118,7 +119,7 @@ Navigate to the `File Index` tab and you will see 2 sections:
 2. File list:
    - This section shows the list of files that have been uploaded to the application and allows users to delete them.
 
-## Chat with your documents
+## 3. Chat with your documents
 
 ![chat tab](https://raw.githubusercontent.com/Cinnamon/kotaemon/main/docs/images/chat-tab.png)