Compare commits
3 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
4fff318ea9 | ||
|
|
ea6efd553d | ||
|
|
d45ef5c622 |
38
docs/.github/workflows/deploy-docs.yml
vendored
Normal file
38
docs/.github/workflows/deploy-docs.yml
vendored
Normal file
@@ -0,0 +1,38 @@
|
|||||||
|
name: Deploy MkDocs
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
- master
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: write
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
deploy:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
|
||||||
|
- name: Setup Python
|
||||||
|
uses: actions/setup-python@v4
|
||||||
|
with:
|
||||||
|
python-version: '3.x'
|
||||||
|
|
||||||
|
- name: Install dependencies
|
||||||
|
run: |
|
||||||
|
python -m pip install --upgrade pip
|
||||||
|
pip install mkdocs-material
|
||||||
|
pip install mkdocs-minify-plugin
|
||||||
|
pip install mkdocs-git-revision-date-plugin
|
||||||
|
pip install mkdocs-mkdocstrings
|
||||||
|
pip install mkdocs-social-plugin
|
||||||
|
pip install mkdocs-redirects
|
||||||
|
|
||||||
|
- name: Deploy
|
||||||
|
run: |
|
||||||
|
git config --global user.name "github-actions[bot]"
|
||||||
|
git config --global user.email "github-actions[bot]@users.noreply.github.com"
|
||||||
|
mkdocs gh-deploy --force
|
||||||
@@ -232,3 +232,11 @@ The current API version is v1. Include the version in the URL:
|
|||||||
- [Core Functions](core.md) - Detailed endpoint documentation
|
- [Core Functions](core.md) - Detailed endpoint documentation
|
||||||
- [Architecture Overview](../architecture.md) - System design details
|
- [Architecture Overview](../architecture.md) - System design details
|
||||||
- [Troubleshooting](../troubleshooting.md) - Common issues and solutions
|
- [Troubleshooting](../troubleshooting.md) - Common issues and solutions
|
||||||
|
|
||||||
|
# API Reference
|
||||||
|
|
||||||
|
The Advanced Home Assistant MCP provides several APIs for integration and automation:
|
||||||
|
|
||||||
|
- [Core API](core-api.md) - Primary interface for system control
|
||||||
|
- [SSE API](sse.md) - Server-Sent Events for real-time updates
|
||||||
|
- [Core Functions](core.md) - Essential system functions
|
||||||
103
docs/deployment.md
Normal file
103
docs/deployment.md
Normal file
@@ -0,0 +1,103 @@
|
|||||||
|
# Deployment Guide
|
||||||
|
|
||||||
|
This documentation is automatically deployed to GitHub Pages using GitHub Actions. Here's how it works and how to manage deployments.
|
||||||
|
|
||||||
|
## Automatic Deployment
|
||||||
|
|
||||||
|
The documentation is automatically deployed when changes are pushed to the `main` or `master` branch. The deployment process:
|
||||||
|
|
||||||
|
1. Triggers on push to main/master
|
||||||
|
2. Sets up Python environment
|
||||||
|
3. Installs required dependencies
|
||||||
|
4. Builds the documentation
|
||||||
|
5. Deploys to the `gh-pages` branch
|
||||||
|
|
||||||
|
### GitHub Actions Workflow
|
||||||
|
|
||||||
|
The deployment is handled by the workflow in `.github/workflows/deploy-docs.yml`:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
name: Deploy MkDocs
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches:
|
||||||
|
- main
|
||||||
|
- master
|
||||||
|
```
|
||||||
|
|
||||||
|
## Manual Deployment
|
||||||
|
|
||||||
|
If needed, you can deploy manually using:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Install dependencies
|
||||||
|
pip install -r docs/requirements.txt
|
||||||
|
|
||||||
|
# Deploy to GitHub Pages
|
||||||
|
mkdocs gh-deploy --force
|
||||||
|
```
|
||||||
|
|
||||||
|
## Best Practices
|
||||||
|
|
||||||
|
### 1. Documentation Updates
|
||||||
|
- Test locally before pushing: `mkdocs serve`
|
||||||
|
- Verify all links work
|
||||||
|
- Ensure images are optimized
|
||||||
|
- Check mobile responsiveness
|
||||||
|
|
||||||
|
### 2. Version Control
|
||||||
|
- Keep documentation in sync with code versions
|
||||||
|
- Use meaningful commit messages
|
||||||
|
- Tag important documentation versions
|
||||||
|
|
||||||
|
### 3. Content Guidelines
|
||||||
|
- Use consistent formatting
|
||||||
|
- Keep navigation structure logical
|
||||||
|
- Include examples where appropriate
|
||||||
|
- Maintain up-to-date screenshots
|
||||||
|
|
||||||
|
### 4. Maintenance
|
||||||
|
- Regularly review and update content
|
||||||
|
- Check for broken links
|
||||||
|
- Update dependencies
|
||||||
|
- Monitor GitHub Actions logs
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
|
||||||
|
### Common Issues
|
||||||
|
|
||||||
|
1. **Failed Deployments**
|
||||||
|
- Check GitHub Actions logs
|
||||||
|
- Verify dependencies are up to date
|
||||||
|
- Ensure all required files exist
|
||||||
|
|
||||||
|
2. **Broken Links**
|
||||||
|
- Run `mkdocs build --strict`
|
||||||
|
- Use relative paths in markdown
|
||||||
|
- Check case sensitivity
|
||||||
|
|
||||||
|
3. **Style Issues**
|
||||||
|
- Verify theme configuration
|
||||||
|
- Check CSS customizations
|
||||||
|
- Test on multiple browsers
|
||||||
|
|
||||||
|
## Configuration Files
|
||||||
|
|
||||||
|
### requirements.txt
|
||||||
|
|
||||||
|
Create a requirements file for documentation dependencies:
|
||||||
|
|
||||||
|
```txt
|
||||||
|
mkdocs-material
|
||||||
|
mkdocs-minify-plugin
|
||||||
|
mkdocs-git-revision-date-plugin
|
||||||
|
mkdocs-mkdocstrings
|
||||||
|
mkdocs-social-plugin
|
||||||
|
mkdocs-redirects
|
||||||
|
```
|
||||||
|
|
||||||
|
## Monitoring
|
||||||
|
|
||||||
|
- Check [GitHub Pages settings](https://github.com/jango-blockchained/advanced-homeassistant-mcp/settings/pages)
|
||||||
|
- Monitor build status in Actions tab
|
||||||
|
- Verify site accessibility
|
||||||
8
docs/getting-started/index.md
Normal file
8
docs/getting-started/index.md
Normal file
@@ -0,0 +1,8 @@
|
|||||||
|
# Getting Started
|
||||||
|
|
||||||
|
Welcome to the Advanced Home Assistant MCP getting started guide. Follow these steps to begin:
|
||||||
|
|
||||||
|
1. [Installation](installation.md)
|
||||||
|
2. [Configuration](configuration.md)
|
||||||
|
3. [Docker Setup](docker.md)
|
||||||
|
4. [Quick Start](quickstart.md)
|
||||||
@@ -4,9 +4,18 @@ title: Home
|
|||||||
nav_order: 1
|
nav_order: 1
|
||||||
---
|
---
|
||||||
|
|
||||||
# 🏠 MCP Server for Home Assistant
|
# Advanced Home Assistant MCP
|
||||||
|
|
||||||
Welcome to the Model Context Protocol (MCP) Server documentation! This guide will help you get started with integrating a lightweight automation tool with your Home Assistant setup.
|
Welcome to the Advanced Home Assistant Master Control Program documentation.
|
||||||
|
|
||||||
|
This documentation provides comprehensive information about setting up, configuring, and using the Advanced Home Assistant MCP system.
|
||||||
|
|
||||||
|
## Quick Links
|
||||||
|
|
||||||
|
- [Getting Started](getting-started/index.md)
|
||||||
|
- [API Reference](api/index.md)
|
||||||
|
- [Configuration Guide](getting-started/configuration.md)
|
||||||
|
- [Docker Setup](getting-started/docker.md)
|
||||||
|
|
||||||
## What is MCP Server?
|
## What is MCP Server?
|
||||||
|
|
||||||
|
|||||||
1
docs/requirements.txt
Normal file
1
docs/requirements.txt
Normal file
@@ -0,0 +1 @@
|
|||||||
|
|
||||||
36
mkdocs.yml
36
mkdocs.yml
@@ -1,6 +1,6 @@
|
|||||||
site_name: Claude Desktop
|
site_name: Advanced Home Assistant MCP
|
||||||
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
|
||||||
|
|
||||||
theme:
|
theme:
|
||||||
name: material
|
name: material
|
||||||
@@ -28,6 +28,9 @@ theme:
|
|||||||
- search.suggest
|
- search.suggest
|
||||||
- search.highlight
|
- search.highlight
|
||||||
- content.code.copy
|
- content.code.copy
|
||||||
|
- content.tabs.link
|
||||||
|
- content.tooltips
|
||||||
|
- toc.integrate
|
||||||
|
|
||||||
markdown_extensions:
|
markdown_extensions:
|
||||||
- pymdownx.highlight:
|
- pymdownx.highlight:
|
||||||
@@ -39,34 +42,38 @@ markdown_extensions:
|
|||||||
- pymdownx.details
|
- pymdownx.details
|
||||||
- attr_list
|
- attr_list
|
||||||
- md_in_html
|
- md_in_html
|
||||||
|
- pymdownx.emoji
|
||||||
|
- pymdownx.tasklist
|
||||||
|
- footnotes
|
||||||
|
- tables
|
||||||
|
|
||||||
plugins:
|
plugins:
|
||||||
- search
|
- search
|
||||||
- git-revision-date-localized:
|
- minify:
|
||||||
type: date
|
minify_html: true
|
||||||
|
- git-revision-date
|
||||||
- mkdocstrings:
|
- mkdocstrings:
|
||||||
default_handler: python
|
default_handler: python
|
||||||
handlers:
|
- social
|
||||||
python:
|
- tags
|
||||||
options:
|
- redirects
|
||||||
show_source: true
|
- gh-deploy
|
||||||
|
|
||||||
nav:
|
nav:
|
||||||
- Home: index.md
|
- Home: index.md
|
||||||
- Usage: usage.md
|
- Usage: usage.md
|
||||||
- API: api.md
|
|
||||||
- Configuration:
|
- Configuration:
|
||||||
- Claude Desktop Config: claude_desktop_config.md
|
- Claude Desktop Config: claude_desktop_config.md
|
||||||
- Cline Config: cline_config.md
|
- Client Config: client_config.md
|
||||||
- Getting Started:
|
- Getting Started:
|
||||||
- Overview: getting-started.md
|
- Overview: getting-started/index.md
|
||||||
- Installation: getting-started/installation.md
|
- Installation: getting-started/installation.md
|
||||||
- Configuration: getting-started/configuration.md
|
- Configuration: getting-started/configuration.md
|
||||||
- Docker Setup: getting-started/docker.md
|
- Docker Setup: getting-started/docker.md
|
||||||
- Quick Start: getting-started/quickstart.md
|
- Quick Start: getting-started/quickstart.md
|
||||||
- API Reference:
|
- API Reference:
|
||||||
- Overview: api/index.md
|
- Overview: api/index.md
|
||||||
- Core API: api.md
|
- Core API: api/core-api.md
|
||||||
- SSE API: api/sse.md
|
- SSE API: api/sse.md
|
||||||
- Core Functions: api/core.md
|
- Core Functions: api/core.md
|
||||||
- Tools:
|
- Tools:
|
||||||
@@ -94,6 +101,7 @@ nav:
|
|||||||
- Interfaces: development/interfaces.md
|
- Interfaces: development/interfaces.md
|
||||||
- Tool Development: development/tools.md
|
- Tool Development: development/tools.md
|
||||||
- Testing Guide: testing.md
|
- Testing Guide: testing.md
|
||||||
|
- Deployment Guide: deployment.md
|
||||||
- Architecture: architecture.md
|
- Architecture: architecture.md
|
||||||
- Contributing: contributing.md
|
- Contributing: contributing.md
|
||||||
- Troubleshooting: troubleshooting.md
|
- Troubleshooting: troubleshooting.md
|
||||||
@@ -117,4 +125,4 @@ extra_css:
|
|||||||
extra_javascript:
|
extra_javascript:
|
||||||
- javascripts/extra.js
|
- javascripts/extra.js
|
||||||
|
|
||||||
copyright: Copyright © 2024 Jango Blockchained
|
copyright: Copyright © 2025 jango-blockchained
|
||||||
Reference in New Issue
Block a user