alex/homeassistant-mcp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: standardize documentation file paths and references

Browse Source 
- Update README.md documentation links to use lowercase, consistent file paths
- Remove "(if available)" annotations from documentation references
- Ensure all documentation links point to correct, lowercase markdown files
This commit is contained in:
jango-blockchained
2025-02-04 17:34:31 +01:00
parent 3a54766b61
commit c11b40da9e
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -48,7 +48,7 @@ The MCP Server is built with scalability, resilience, and security in mind:
- **Modular & Extensible:** Designed to support plugins, add-ons, and custom automation scripts, allowing for easy expansion. - **Modular & Extensible:** Designed to support plugins, add-ons, and custom automation scripts, allowing for easy expansion.
- **Secure API Integration:** Implements token-based authentication, rate limiting, and adherence to best security practices. - **Secure API Integration:** Implements token-based authentication, rate limiting, and adherence to best security practices.
_For a deeper dive into the system architecture, please refer to our [Architecture Documentation](docs/ARCHITECTURE.md) (if available)._ For a deeper dive into the system architecture, please refer to our [Architecture Documentation](docs/architecture.md).
## Installation ## Installation
@@ -118,10 +118,10 @@ eventSource.onmessage = (event) => {
Access comprehensive API details and guides in the docs directory: Access comprehensive API details and guides in the docs directory:
- **API Reference:** [API Documentation](docs/API.md) - **API Reference:** [API Documentation](docs/api.md)
- **SSE Documentation:** [SSE API](docs/SSE_API.md) - **SSE Documentation:** [SSE API](docs/sse-api.md)
- **Troubleshooting Guide:** [TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md) - **Troubleshooting Guide:** [Troubleshooting](docs/troubleshooting.md)
- **Architecture Details:** [Architecture Documentation](docs/ARCHITECTURE.md) _(if available)_ - **Architecture Details:** [Architecture Documentation](docs/architecture.md)
## Development ## Development
@@ -160,7 +160,7 @@ The MCP Server is under active development and improvement. Planned enhancements
- **Expanded Integrations:** Support for a wider array of smart home devices and third-party services. - **Expanded Integrations:** Support for a wider array of smart home devices and third-party services.
- **Performance Optimizations:** Continued efforts to reduce latency and improve resource efficiency. - **Performance Optimizations:** Continued efforts to reduce latency and improve resource efficiency.
_For additional details, check out our [Roadmap](docs/ROADMAP.md) (if available)._ For additional details, check out our [Roadmap](docs/roadmap.md).
## Community & Support ## Community & Support
@@ -189,7 +189,7 @@ We welcome your contributions! To get started:
``` ```
5. Commit and push your changes, then open a Pull Request. 5. Commit and push your changes, then open a Pull Request.
_For detailed guidelines, see [CONTRIBUTING.md](CONTRIBUTING.md)._ For detailed guidelines, see [Contributing Guide](docs/contributing.md).
## Troubleshooting & FAQ ## Troubleshooting & FAQ
@@ -199,7 +199,7 @@ _For detailed guidelines, see [CONTRIBUTING.md](CONTRIBUTING.md)._
- **Docker Deployment:** Confirm that Docker is running and that your `.env` file contains the correct settings. - **Docker Deployment:** Confirm that Docker is running and that your `.env` file contains the correct settings.
- **Automation Errors:** Verify entity availability and review your automation configurations for potential issues. - **Automation Errors:** Verify entity availability and review your automation configurations for potential issues.
_For more troubleshooting details, refer to [TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md)._ For more troubleshooting details, refer to [Troubleshooting Guide](docs/troubleshooting.md).
### Frequently Asked Questions ### Frequently Asked Questions