diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index 5db8ec8..26c0676 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -1,64 +1,25 @@ -name: Deploy Documentation to GitHub Pages - +name: Deploy MkDocs on: push: branches: - - main - paths: - - 'docs/**' - - '.github/workflows/deploy-docs.yml' + - main # or master, depending on your default branch + workflow_dispatch: permissions: - contents: read - pages: write - id-token: write - -# Allow only one concurrent deployment -concurrency: - group: "pages" - cancel-in-progress: true + contents: write jobs: - build: + deploy: runs-on: ubuntu-latest steps: - - name: Checkout - uses: actions/checkout@v4 - - - name: Setup Ruby - uses: ruby/setup-ruby@v1 + - uses: actions/checkout@v4 + - uses: actions/setup-python@v5 with: - ruby-version: '3.2' - bundler-cache: true - cache-version: 0 - - - name: Setup Pages - uses: actions/configure-pages@v4 - + python-version: '3.x' - name: Install dependencies run: | - cd docs - bundle install - - - name: Build site - run: | - cd docs - bundle exec jekyll build - env: - JEKYLL_ENV: production - - - 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 - uses: actions/deploy-pages@v4 \ No newline at end of file + pip install mkdocs-material + pip install mkdocs-git-revision-date-localized-plugin + pip install mkdocstrings[python] + - name: Deploy + run: mkdocs gh-deploy --force \ No newline at end of file diff --git a/docs/api.md b/docs/api.md index 1ac5617..731192f 100644 --- a/docs/api.md +++ b/docs/api.md @@ -130,25 +130,25 @@ Basic rate limiting is implemented: async function controlDevice(entityId: string, command: string, params?: Record) { try { const response = await fetch('/api/control', { - method: 'POST', - headers: { + method: 'POST', + 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; } diff --git a/docs/claude_desktop_config.json b/docs/config/claude_desktop_config.json similarity index 100% rename from docs/claude_desktop_config.json rename to docs/config/claude_desktop_config.json diff --git a/docs/cline_config.json b/docs/config/cline_config.json similarity index 100% rename from docs/cline_config.json rename to docs/config/cline_config.json diff --git a/mkdocs.yml b/mkdocs.yml index 30c2cc1..bd4648e 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,23 +1,19 @@ -site_name: Home Assistant MCP -site_description: A bridge between Home Assistant and Language Learning Models -site_url: https://jango-blockchained.github.io/advanced-homeassistant-mcp/ -repo_url: https://github.com/jango-blockchained/advanced-homeassistant-mcp -repo_name: jango-blockchained/advanced-homeassistant-mcp +site_name: Claude Desktop +site_url: https://your-username.github.io/your-repo-name +repo_url: https://github.com/your-username/your-repo-name 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.magiclink - - pymdownx.mark - - pymdownx.smartsymbols - - pymdownx.superfences: - custom_fences: - - name: mermaid - class: mermaid - format: !!python/name:pymdownx.superfences.fence_code_format - - pymdownx.tabbed: - alternate_style: true - - pymdownx.tasklist: - custom_checkbox: true - - pymdownx.tilde + - pymdownx.snippets + - pymdownx.superfences + - admonition + - pymdownx.details + - attr_list + - md_in_html 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 \ No newline at end of file