docs: add comprehensive documentation for MCP project

- Create comprehensive documentation structure using MkDocs
- Add markdown files for API reference, architecture, getting started, and troubleshooting
- Configure GitHub Pages deployment workflow
- Include custom Jekyll and MkDocs configurations
- Add custom styling and layout for documentation site
This commit is contained in:
jango-blockchained
2025-02-04 17:14:39 +01:00
parent d6bb83685d
commit b0ad1cf0ad
18 changed files with 403 additions and 1 deletions

46
docs/index.md Normal file
View File

@@ -0,0 +1,46 @@
---
layout: default
title: Home
nav_order: 1
---
# Model Context Protocol (MCP) Server
## Overview
The Model Context Protocol (MCP) Server is a cutting-edge bridge between Home Assistant and Language Learning Models (LLMs), designed to revolutionize smart home automation and control.
## Key Features
### 🏠 Smart Home Integration
- Natural language control of smart devices
- Real-time device state monitoring
- Advanced automation capabilities
### 🤖 LLM Powered Interactions
- Intuitive voice and text-based commands
- Context-aware device management
- Intelligent automation suggestions
### 🔒 Security & Performance
- Token-based authentication
- High-performance Bun runtime
- Secure, real-time communication protocols
## Documentation
- [Getting Started](getting-started.md) - Installation and basic setup
- [API Reference](api.md) - Complete API documentation
- [SSE API](sse-api.md) - Server-Sent Events API documentation
- [Architecture](architecture.md) - System architecture and design
- [Contributing](contributing.md) - How to contribute to the project
- [Troubleshooting](troubleshooting.md) - Common issues and solutions
## Community and Support
- [GitHub Issues](https://github.com/jango-blockchained/homeassistant-mcp/issues) - Report bugs and request features
- [GitHub Discussions](https://github.com/jango-blockchained/homeassistant-mcp/discussions) - Ask questions and share ideas
## License
Licensed under the MIT License. See [LICENSE](https://github.com/jango-blockchained/homeassistant-mcp/blob/main/LICENSE) for details.