Add MkDocs configuration and deployment workflow

Author: sun

.github/workflows/deploy-docs.yml

@@ -0,0 +1,22 @@
+name: Deploy Documentation
+on:
+  push:
+    branches:
+      - main
+permissions:
+  contents: write
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.x
+      - name: Install dependencies
+        run: |
+          pip install mkdocs-material
+      - name: Build and Deploy
+        run: |
+          mkdocs gh-pages --force

mkdocs.yml

@@ -0,0 +1,87 @@
+site_name: Compileo
+site_description: A modular pipeline for dataset creation and curation
+site_author: SunPCSolutions
+site_url: https://SunPCSolutions.github.io/Compileo/
+
+theme:
+  name: material
+  palette:
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: indigo
+      accent: indigo
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: indigo
+      accent: indigo
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+  features:
+    - navigation.tabs
+    - navigation.sections
+    - navigation.expand
+    - navigation.top
+    - search.suggest
+    - search.highlight
+    - search.share
+    - content.code.copy
+
+markdown_extensions:
+  - admonition
+  - pymdownx.details
+  - pymdownx.superfences
+  - pymdownx.tabbed:
+      alternate_style: true
+  - pymdownx.highlight:
+      anchor_linenums: true
+  - attr_list
+  - md_in_html
+
+nav:
+  - Home: README.md
+  - User Guide:
+      - API Authentication: docs/userGuide/api_authentication.md
+      - Benchmarking API: docs/userGuide/benchmarkingapi.md
+      - Benchmarking GUI: docs/userGuide/benchmarkinggui.md
+      - Chunk API: docs/userGuide/chunkapi.md
+      - Chunk CLI: docs/userGuide/chunkcli.md
+      - Chunk GUI: docs/userGuide/chunkgui.md
+      - Dataset Gen API: docs/userGuide/datasetgenapi.md
+      - Dataset Gen CLI: docs/userGuide/datasetgencli.md
+      - Dataset Gen GUI: docs/userGuide/datasetgengui.md
+      - Dataset Quality API: docs/userGuide/datasetqualapi.md
+      - Dataset Quality GUI: docs/userGuide/datasetqualgui.md
+      - Datasets API: docs/userGuide/datasetsapi.md
+      - Dataset Versioning API: docs/userGuide/datasetversioningapi.md
+      - Dataset Versioning CLI: docs/userGuide/datasetversioningcli.md
+      - Docker Install: docs/userGuide/dockerInstall.md
+      - Documents API: docs/userGuide/documentsapi.md
+      - Documents CLI: docs/userGuide/documentscli.md
+      - Documents GUI: docs/userGuide/documentsgui.md
+      - Extraction API: docs/userGuide/extractionapi.md
+      - Extraction CLI: docs/userGuide/extractioncli.md
+      - Extraction GUI: docs/userGuide/extractiongui.md
+      - GUI User Guide: docs/userGuide/gui_user_guide.md
+      - Ingestion API: docs/userGuide/ingestionapi.md
+      - Ingestion GUI: docs/userGuide/ingestiongui.md
+      - Job Handling API: docs/userGuide/jobhandlingapi.md
+      - Job Handling CLI: docs/userGuide/jobhandlingcli.md
+      - Job Handling GUI: docs/userGuide/jobhandlinggui.md
+      - Jobs API: docs/userGuide/jobsapi.md
+      - Logging: docs/userGuide/logging.md
+      - Performance API: docs/userGuide/performanceapi.md
+      - Plugins: docs/userGuide/plugins.md
+      - Plugins API: docs/userGuide/pluginsapi.md
+      - Plugins CLI: docs/userGuide/pluginscli.md
+      - Projects API: docs/userGuide/projectsapi.md
+      - Prompts API: docs/userGuide/promptsapi.md
+      - Settings GUI: docs/userGuide/settingsgui.md
+      - Taxonomy API: docs/userGuide/taxonomyapi.md
+      - Taxonomy CLI: docs/userGuide/taxonomycli.md
+      - Taxonomy GUI: docs/userGuide/taxonomygui.md
+  - Developers:
+      - Plugin Development: docs/developers/plugin_development_guide.md