Update docs (#106)

docs/contributing.md

@@ -139,8 +139,8 @@ Examples: https://github.com/Cinnamon/kotaemon/pull/2
 - 1st line message is the PR title.
 - The text area is the PR description.
 
-![image](https://github.com/Cinnamon/kotaemon/assets/35283585/e2593010-d7ef-46e3-8719-6fcae0315b5d)
-![image](https://github.com/Cinnamon/kotaemon/assets/35283585/bfe6a117-85cd-4dd4-b432-197c791a9901)
+![image](images/274787925-e2593010-d7ef-46e3-8719-6fcae0315b5d.png)
+![image](images/274787941-bfe6a117-85cd-4dd4-b432-197c791a9901.png)
 
 ## Develop pipelines
 

docs/overview.md

@@ -3,8 +3,17 @@
 `kotaemon` library focuses on the AI building blocks to implement the Kotaemon. It can be used in both client project and in product development. It consists of base interfaces, core components and a list of utilities:
 
 - Base interfaces: `kotaemon` defines the base interface of a component in a pipeline. A pipeline is also a component. By clearly define this interface, a pipeline of steps can be easily constructed and orchestrated.
-- Core components: `kotaemon` implements (or wraps 3rd-party libraries 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 [Pipeline Components](Pipeline-Components) and [Data & Data Structure Components](Data-&-Data-Structure-Components) sections.
-- List of utilities: `lib-knowledge` 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](Utilities) section.
+- Core components: `kotaemon` implements (or wraps 3rd-party libraries
+  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.
+- List of utilities: `lib-knowledge` 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 [Tutorial/Utilities](/ultilities) section.
 
 ```mermaid
 mindmap

docs/scripts/generate_reference_docs.py

@@ -13,6 +13,8 @@ while doc_dir.name != doc_dir_name and doc_dir != doc_dir.parent:
 if doc_dir == doc_dir.parent:
     raise ValueError(f"root_name ({doc_dir_name}) not in path ({str(Path(__file__))}).")
 
+nav_title_map = {"cli": "CLI", "llms": "LLMs"}
+
 
 def generate_docs_for_src_code(
     code_dir: Path, target_doc_folder: str, ignored_modules: Iterable[Any] = []
@@ -53,7 +55,9 @@ def generate_docs_for_src_code(
         if ignore:
             continue
 
-        nav_titles = [name.replace("_", " ").title() for name in parts]
+        nav_titles = [
+            nav_title_map.get(name, name.replace("_", " ").title()) for name in parts
+        ]
         nav[nav_titles] = doc_path.as_posix()
 
         with mkdocs_gen_files.open(full_doc_path, "w") as f:
@@ -69,7 +73,7 @@ def generate_docs_for_src_code(
 
 
 generate_docs_for_src_code(
-    code_dir=doc_dir.parent / "libs" / "kotaemon",
+    code_dir=doc_dir.parent / "libs" / "kotaemon" / "kotaemon",
     target_doc_folder="reference",
     ignored_modules={"contribs"},
 )

docs/ultilities.md

@@ -2,7 +2,7 @@ Utilities detail can be referred in the sub-pages of this section.
 
 ## Prompt engineering UI
 
-![chat-ui](https://github.com/Cinnamon/kotaemon/assets/35283585/ac8f9aac-d853-4571-a48b-d866a99eaf3e)
+![chat-ui](images/271332562-ac8f9aac-d853-4571-a48b-d866a99eaf3e.png)
 
 **_Important:_** despite the name prompt engineering UI, this tool allows DMs to test any kind of parameters that are exposed by AIRs. Prompt is one kind of param. There can be other type of params that DMs can tweak (e.g. top_k, temperature...).
 
@@ -146,7 +146,7 @@ $ kh promptui run <path/to/config/file.yml>
 
 This will generate an UI as follow:
 
-![Screenshot from 2023-09-20 12-20-31](https://github.com/Cinnamon/kotaemon/assets/35283585/9ac1b95a-b667-42e7-b318-98a1b805d6df)
+![Screenshot from 2023-09-20 12-20-31](images/269170198-9ac1b95a-b667-42e7-b318-98a1b805d6df.png)
 
 where: