docs: update mkdocs develop guide #none

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">

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

docs/development/index.md

@@ -1 +1,5 @@
---8<-- "README.md"
+{%
+    include-markdown "../../README.md"
+    start="<!-- start-intro -->"
+    end="<!-- end-intro -->"
+%}

mkdocs.yml

@@ -80,6 +80,7 @@ plugins:
       fallback_to_build_date: true
   - section-index
   - mkdocs-video
+  - include-markdown
 
 theme:
   features: