9d125a87d9
- Significantly expand and reorganize documentation navigation structure - Add new sections for AI features, speech processing, and development guidelines - Enhance theme configuration with additional MkDocs features - Remove test migration guide from development documentation - Improve documentation organization and readability
169 lines
4.8 KiB
YAML
169 lines
4.8 KiB
YAML
site_name: Home Assistant MCP
|
|
site_url: https://jango-blockchained.github.io/homeassistant-mcp
|
|
repo_url: https://github.com/jango-blockchained/homeassistant-mcp
|
|
repo_name: jango-blockchained/homeassistant-mcp
|
|
edit_uri: edit/main/docs/
|
|
|
|
theme:
|
|
name: material
|
|
features:
|
|
- navigation.instant
|
|
- navigation.tracking
|
|
- navigation.sections
|
|
- navigation.expand
|
|
- navigation.indexes
|
|
- navigation.top
|
|
- toc.follow
|
|
- search.suggest
|
|
- search.highlight
|
|
- content.code.copy
|
|
- content.code.annotate
|
|
palette:
|
|
- scheme: default
|
|
primary: indigo
|
|
accent: indigo
|
|
toggle:
|
|
icon: material/brightness-7
|
|
name: Switch to dark mode
|
|
- scheme: slate
|
|
primary: indigo
|
|
accent: indigo
|
|
toggle:
|
|
icon: material/brightness-4
|
|
name: Switch to light mode
|
|
icon:
|
|
repo: fontawesome/brands/github
|
|
favicon: assets/favicon.png
|
|
logo: assets/logo.png
|
|
|
|
plugins:
|
|
- search
|
|
- mermaid2
|
|
- git-revision-date-localized:
|
|
type: date
|
|
- minify:
|
|
minify_html: true
|
|
|
|
markdown_extensions:
|
|
- admonition
|
|
- attr_list
|
|
- def_list
|
|
- footnotes
|
|
- meta
|
|
- toc:
|
|
permalink: true
|
|
- pymdownx.arithmatex
|
|
- pymdownx.betterem:
|
|
smart_enable: all
|
|
- pymdownx.caret
|
|
- pymdownx.critic
|
|
- pymdownx.details
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:materialx.emoji.twemoji
|
|
emoji_generator: !!python/name:materialx.emoji.to_svg
|
|
- pymdownx.highlight
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.keys
|
|
- 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
|
|
|
|
nav:
|
|
- Home: index.md
|
|
- Getting Started:
|
|
- Quick Start: getting-started/quick-start.md
|
|
- Installation:
|
|
- Basic Setup: getting-started/installation.md
|
|
- Docker Setup: getting-started/docker.md
|
|
- GPU Support: getting-started/gpu.md
|
|
- Configuration:
|
|
- Environment: getting-started/configuration.md
|
|
- Security: getting-started/security.md
|
|
- Performance: getting-started/performance.md
|
|
|
|
- Core Features:
|
|
- Overview: features/core-features.md
|
|
- Device Control: features/device-control.md
|
|
- Automation: features/automation.md
|
|
- Events & States: features/events-states.md
|
|
- Security: features/security.md
|
|
|
|
- AI Features:
|
|
- Overview: ai/overview.md
|
|
- NLP Integration: ai/nlp.md
|
|
- Custom Prompts: ai/prompts.md
|
|
- Model Configuration: ai/models.md
|
|
- Best Practices: ai/best-practices.md
|
|
|
|
- Speech Processing:
|
|
- Overview: speech/overview.md
|
|
- Wake Word Detection: speech/wake-word.md
|
|
- Speech-to-Text: speech/stt.md
|
|
- GPU Acceleration: speech/gpu.md
|
|
- Language Support: speech/languages.md
|
|
|
|
- Tools & Utilities:
|
|
- Overview: tools/overview.md
|
|
- Analyzer CLI:
|
|
- Installation: tools/analyzer/installation.md
|
|
- Usage: tools/analyzer/usage.md
|
|
- Configuration: tools/analyzer/config.md
|
|
- Examples: tools/analyzer/examples.md
|
|
- Speech Examples:
|
|
- Basic Usage: tools/speech/basic.md
|
|
- Advanced Features: tools/speech/advanced.md
|
|
- Troubleshooting: tools/speech/troubleshooting.md
|
|
- Claude Desktop:
|
|
- Setup: tools/claude/setup.md
|
|
- Integration: tools/claude/integration.md
|
|
- Configuration: tools/claude/config.md
|
|
|
|
- API Reference:
|
|
- Overview: api/overview.md
|
|
- REST API:
|
|
- Authentication: api/rest/auth.md
|
|
- Endpoints: api/rest/endpoints.md
|
|
- Examples: api/rest/examples.md
|
|
- WebSocket API:
|
|
- Connection: api/websocket/connection.md
|
|
- Events: api/websocket/events.md
|
|
- Examples: api/websocket/examples.md
|
|
- SSE:
|
|
- Setup: api/sse/setup.md
|
|
- Events: api/sse/events.md
|
|
- Examples: api/sse/examples.md
|
|
|
|
- Development:
|
|
- Setup: development/setup.md
|
|
- Architecture: development/architecture.md
|
|
- Contributing: development/contributing.md
|
|
- Testing:
|
|
- Overview: development/testing/overview.md
|
|
- Unit Tests: development/testing/unit.md
|
|
- Integration Tests: development/testing/integration.md
|
|
- E2E Tests: development/testing/e2e.md
|
|
- Guidelines:
|
|
- Code Style: development/guidelines/code-style.md
|
|
- Documentation: development/guidelines/documentation.md
|
|
- Git Workflow: development/guidelines/git-workflow.md
|
|
|
|
- Troubleshooting:
|
|
- Common Issues: troubleshooting/common-issues.md
|
|
- FAQ: troubleshooting/faq.md
|
|
- Known Bugs: troubleshooting/known-bugs.md
|
|
- Support: troubleshooting/support.md
|
|
|
|
- About:
|
|
- License: about/license.md
|
|
- Author: about/author.md
|
|
- Changelog: about/changelog.md
|
|
- Roadmap: about/roadmap.md |