docs: expand documentation with new sections and deployment guides
- Add Examples section to MkDocs navigation - Create initial Examples overview page with placeholder content - Add Docker deployment guide to Getting Started section - Update installation documentation with Smithery configuration details
This commit is contained in:
22
docs/examples/index.md
Normal file
22
docs/examples/index.md
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
---
|
||||||
|
layout: default
|
||||||
|
title: Examples
|
||||||
|
nav_order: 7
|
||||||
|
has_children: true
|
||||||
|
---
|
||||||
|
|
||||||
|
# Example Projects 📚
|
||||||
|
|
||||||
|
This section contains examples and tutorials for common MCP Server integrations.
|
||||||
|
|
||||||
|
## Speech-to-Text Integration
|
||||||
|
|
||||||
|
Example of integrating speech recognition with MCP Server:
|
||||||
|
|
||||||
|
```typescript
|
||||||
|
// From examples/speech-to-text-example.ts
|
||||||
|
// Add example code and explanation
|
||||||
|
```
|
||||||
|
|
||||||
|
## More Examples Coming Soon
|
||||||
|
...
|
||||||
10
docs/getting-started/docker.md
Normal file
10
docs/getting-started/docker.md
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
---
|
||||||
|
layout: default
|
||||||
|
title: Docker Deployment
|
||||||
|
parent: Getting Started
|
||||||
|
nav_order: 3
|
||||||
|
---
|
||||||
|
|
||||||
|
# Docker Deployment Guide 🐳
|
||||||
|
|
||||||
|
Detailed guide for deploying MCP Server with Docker...
|
||||||
@@ -23,6 +23,16 @@ Before installing MCP Server, ensure you have:
|
|||||||
|
|
||||||
The easiest way to install MCP Server is through Smithery:
|
The easiest way to install MCP Server is through Smithery:
|
||||||
|
|
||||||
|
#### Smithery Configuration
|
||||||
|
|
||||||
|
The project includes a `smithery.yaml` configuration:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
# Add smithery.yaml contents and explanation
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Installation Steps
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npx -y @smithery/cli install @jango-blockchained/advanced-homeassistant-mcp --client claude
|
npx -y @smithery/cli install @jango-blockchained/advanced-homeassistant-mcp --client claude
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -91,6 +91,12 @@ nav:
|
|||||||
- Architecture: architecture.md
|
- Architecture: architecture.md
|
||||||
- Contributing: contributing.md
|
- Contributing: contributing.md
|
||||||
- Troubleshooting: troubleshooting.md
|
- Troubleshooting: troubleshooting.md
|
||||||
|
- Examples:
|
||||||
|
- Overview: examples/index.md
|
||||||
|
- Development:
|
||||||
|
- Setup: development/setup.md
|
||||||
|
- Testing: development/testing.md
|
||||||
|
- CI/CD: development/cicd.md
|
||||||
|
|
||||||
extra:
|
extra:
|
||||||
social:
|
social:
|
||||||
|
|||||||
Reference in New Issue
Block a user