documentation added

aymanehachcham · Oct 21, 2023 · 8e26b27 · 8e26b27
1 parent 8be54c7
commit 8e26b27
Show file tree

Hide file tree

Showing 61 changed files with 11,870 additions and 1 deletion.
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,17 @@
+# Welcome to MkDocs
+
+For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+
+## Commands
+
+* `mkdocs new [dir-name]` - Create a new project.
+* `mkdocs serve` - Start the live-reloading docs server.
+* `mkdocs build` - Build the documentation site.
+* `mkdocs -h` - Print help message and exit.
+
+## Project layout
+
+    mkdocs.yml    # The configuration file.
+    docs/
+        index.md  # The documentation homepage.
+        ...       # Other markdown pages, images and other files.
diff --git a/docs/mentor_mingle/llm_handler.md b/docs/mentor_mingle/llm_handler.md
diff --git a/docs/persona/personification.md b/docs/persona/personification.md
diff --git a/docs/tot/config.md b/docs/tot/config.md
diff --git a/docs/tot/process.md b/docs/tot/process.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,64 @@
+site_name: Mentor Mingle
+
+theme:
+  name: material
+  font:
+    text: Roboto
+    code: Roboto Mono
+  icon:
+    logo: simple/bosch
+  features:
+    - navigation.tabs
+    - navigation.tabs.sticky
+    - navigation.sections
+    - navigation.expand
+    - navigation.prune
+    - navigation.path
+    - navigation.top
+    - navigation.tracking
+    - search.suggest
+    - search.highlight
+    - content.code.copy
+    - content.code.prettify
+
+  language: en
+  palette:
+    - scheme: default
+      toggle:
+        icon: material/toggle-switch-off-outline
+        name: Switch to dark mode
+      primary: teal
+      accent: purple
+    - scheme: slate
+      toggle:
+        icon: material/toggle-switch
+        name: Switch to light mode
+      primary: indigo
+      accent: deep purple
+
+plugins:
+  - search
+  - mkdocstrings
+
+extra_css:
+  - assets/custom.css
+
+nav:
+  - Home: index.md
+  - Mentor Mingle:
+      - LLM Handler: mentor_mingle/llm_handler.md
+  - Personas:
+      - Personification: persona/personification.md
+  - Tree of Thought:
+        - Working Process: tot/process.md
+        - Config Schema: tot/config.md
+
+markdown_extensions:
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences
+  - admonition
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -35,6 +35,13 @@ flake8 = "^6.1.0"
 pylint = "^3.0.1"
 black = "^23.10.0"
 
+
+[tool.poetry.group.docs.dependencies]
+mkdocs = "^1.5.3"
+mkdocstrings-python = "^1.7.3"
+markdown-include = "^0.8.1"
+mkdocs-material = "^9.4.6"
+
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"