docs: Enhance GitHub Actions documentation deployment workflow

- Improve documentation deployment process with more robust Git configuration
- Add explicit Git user setup for GitHub Actions
- Modify deployment script to create a clean gh-pages branch
- Ensure precise documentation site generation and deployment

.github/workflows/deploy-docs.yml

@@ -1,64 +1,38 @@
-name: Deploy Documentation to GitHub Pages
+name: Deploy MkDocs
-
 on:
   push:
     branches:
-      - main
+      - main  # or master, depending on your default branch
-    paths:
+  workflow_dispatch:
-      - 'docs/**'
-      - '.github/workflows/deploy-docs.yml'
 
 permissions:
-  contents: read
+  contents: write
-  pages: write
-  id-token: write
-
-# Allow only one concurrent deployment
-concurrency:
-  group: "pages"
-  cancel-in-progress: true
 
 jobs:
-  build:
+  deploy:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
+      - uses: actions/checkout@v4
-        uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
-
-      - name: Setup Ruby
-        uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '3.2'
+          python-version: '3.x'
-          bundler-cache: true
-          cache-version: 0
-
-      - name: Setup Pages
-        uses: actions/configure-pages@v4
-
       - name: Install dependencies
         run: |
-          cd docs
+          pip install mkdocs-material
-          bundle install
+          pip install mkdocs-git-revision-date-localized-plugin
-
+          pip install mkdocstrings[python]
-      - name: Build site
+      - name: Configure Git
         run: |
-          cd docs
+          git config --global user.name "github-actions[bot]"
-          bundle exec jekyll build
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
-        env:
+      - name: Build docs
-          JEKYLL_ENV: production
+        run: mkdocs build
-
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v3
-        with:
-          path: docs/_site
-
-  deploy:
-    needs: build
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: ubuntu-latest
-    steps:
       - name: Deploy to GitHub Pages
-        id: deployment
+        run: |
-        uses: actions/deploy-pages@v4 
+          git checkout --orphan gh-pages
+          git rm -rf .
+          mv site/* .
+          rm -rf site
+          git add .
+          git commit -m "docs: Update documentation"
+          git push origin gh-pages --force 

docs/api.md

@@ -130,25 +130,25 @@ Basic rate limiting is implemented:
 async function controlDevice(entityId: string, command: string, params?: Record<string, unknown>) {
   try {
     const response = await fetch('/api/control', {
-      method: 'POST',
+    method: 'POST',
-      headers: {
+    headers: {
         'Content-Type': 'application/json',
         'Authorization': `Bearer ${token}`
-      },
+    },
-      body: JSON.stringify({
+    body: JSON.stringify({
         entity_id: entityId,
         command,
         parameters: params
-      })
+    })
-    });
+  });
-
+  
     if (!response.ok) {
       const error = await response.json();
       throw new Error(error.message);
     }
 
     return await response.json();
-  } catch (error) {
+} catch (error) {
     console.error('Device control failed:', error);
     throw error;
   }

mkdocs.yml

@@ -1,23 +1,19 @@
-site_name: Home Assistant MCP
+site_name: Claude Desktop
-site_description: A bridge between Home Assistant and Language Learning Models
+site_url: https://your-username.github.io/your-repo-name
-site_url: https://jango-blockchained.github.io/advanced-homeassistant-mcp/
+repo_url: https://github.com/your-username/your-repo-name
-repo_url: https://github.com/jango-blockchained/advanced-homeassistant-mcp
-repo_name: jango-blockchained/advanced-homeassistant-mcp
 
 theme:
   name: material
   logo: assets/images/logo.png
   favicon: assets/images/favicon.ico
   palette:
-    - media: "(prefers-color-scheme: light)"
+    - scheme: default
-      scheme: default
       primary: indigo
       accent: indigo
       toggle:
         icon: material/brightness-7
         name: Switch to dark mode
-    - media: "(prefers-color-scheme: dark)"
+    - scheme: slate
-      scheme: slate
       primary: indigo
       accent: indigo
       toggle:
@@ -34,39 +30,15 @@ theme:
     - content.code.copy
 
 markdown_extensions:
-  - admonition
-  - attr_list
-  - def_list
-  - footnotes
-  - meta
-  - toc:
-      permalink: true
-  - pymdownx.arithmatex:
-      generic: true
-  - pymdownx.betterem:
-      smart_enable: all
-  - pymdownx.caret
-  - pymdownx.details
-  - pymdownx.emoji:
-      emoji_index: !!python/name:material.extensions.emoji.twemoji
-      emoji_generator: !!python/name:material.extensions.emoji.to_svg
   - pymdownx.highlight:
       anchor_linenums: true
   - pymdownx.inlinehilite
-  - pymdownx.keys
+  - pymdownx.snippets
-  - pymdownx.magiclink
+  - pymdownx.superfences
-  - pymdownx.mark
+  - admonition
-  - pymdownx.smartsymbols
+  - pymdownx.details
-  - pymdownx.superfences:
+  - attr_list
-      custom_fences:
+  - md_in_html
-        - name: mermaid
-          class: mermaid
-          format: !!python/name:pymdownx.superfences.fence_code_format
-  - pymdownx.tabbed:
-      alternate_style: true
-  - pymdownx.tasklist:
-      custom_checkbox: true
-  - pymdownx.tilde
 
 plugins:
   - search
@@ -81,13 +53,17 @@ plugins:
 
 nav:
   - Home: index.md
+  - Usage: usage.md
+  - API: api.md
+  - Configuration:
+    - Claude Desktop Config: claude_desktop_config.md
+    - Cline Config: cline_config.md
   - Getting Started:
     - Overview: getting-started.md
     - Installation: getting-started/installation.md
     - Configuration: getting-started/configuration.md
     - Docker Setup: getting-started/docker.md
     - Quick Start: getting-started/quickstart.md
-    - Usage: usage.md
   - API Reference:
     - Overview: api/index.md
     - Core API: api.md
@@ -136,6 +112,9 @@ extra:
     property: !ENV GOOGLE_ANALYTICS_KEY
 
 extra_css:
-  - assets/stylesheets/extra.css
+  - stylesheets/extra.css
+
+extra_javascript:
+  - javascripts/extra.js
 
 copyright: Copyright © 2024 Jango Blockchained