From d42b4773cb878bebc1d8b36c923fcb743a9f1dfd Mon Sep 17 00:00:00 2001
From: Tadashi <tadashi@cinnamon.is>
Date: Sat, 16 Nov 2024 11:09:23 +0700
Subject: [PATCH] docs: update mkdocs develop guide #none

---
 README.md                 | 4 ++++
 doc_env_reqs.txt          | 2 +-
 docs/development/index.md | 6 +++++-
 mkdocs.yml                | 1 +
 4 files changed, 11 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 7e796ad..3e47d4e 100644
--- a/README.md
+++ b/README.md
@@ -26,6 +26,8 @@ developers in mind.
 
 </div>
 
+<!-- start-intro -->
+
 ## Introduction
 
 This project serves as a functional RAG UI for both end users who want to do QA on their
@@ -355,6 +357,8 @@ This file provides another way to configure your models and credentials.
 
 > (more instruction WIP).
 
+<!-- end-intro -->
+
 ## Star History
 
 <a href="https://star-history.com/#Cinnamon/kotaemon&Date">
diff --git a/doc_env_reqs.txt b/doc_env_reqs.txt
index 48a321f..ba7546d 100644
--- a/doc_env_reqs.txt
+++ b/doc_env_reqs.txt
@@ -3,7 +3,7 @@ mkdocstrings[python]
 mkdocs-material
 mkdocs-gen-files
 mkdocs-literate-nav
-mkdocs-video
 mkdocs-git-revision-date-localized-plugin
 mkdocs-section-index
+mkdocs-include-markdown-plugin[cache]
 mdx_truly_sane_lists
diff --git a/docs/development/index.md b/docs/development/index.md
index 612c7a5..5c48712 100644
--- a/docs/development/index.md
+++ b/docs/development/index.md
@@ -1 +1,5 @@
---8<-- "README.md"
+{%
+    include-markdown "../../README.md"
+    start="<!-- start-intro -->"
+    end="<!-- end-intro -->"
+%}
diff --git a/mkdocs.yml b/mkdocs.yml
index d04ff27..2849b37 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -80,6 +80,7 @@ plugins:
       fallback_to_build_date: true
   - section-index
   - mkdocs-video
+  - include-markdown
 
 theme:
   features: