docs: enhance project documentation with comprehensive updates

- Revamp README.md with improved project overview, architecture diagram, and badges
- Create new development and tools documentation with detailed guides
- Update API documentation with enhanced examples, rate limiting, and security information
- Refactor and consolidate documentation files for better navigation and clarity
- Add emojis and visual improvements to make documentation more engaging
This commit is contained in:
jango-blockchained
2025-02-04 17:49:58 +01:00
parent 5f4ddfbd88
commit d6a5771e01
9 changed files with 360 additions and 82 deletions

View File

@@ -4,7 +4,7 @@ Begin your journey with the Home Assistant MCP Server by following these steps:
- **API Documentation:** Read the [API Documentation](api.md) for available endpoints.
- **Real-Time Updates:** Learn about [Server-Sent Events](sse-api.md) for live communication.
- **Tools:** Explore available [Tools](tools/README.md) for device control and automation.
- **Tools:** Explore available [Tools](tools/tools.md) for device control and automation.
- **Configuration:** Refer to the [Configuration Guide](configuration.md) for setup and advanced settings.
## Troubleshooting
@@ -19,7 +19,7 @@ If you encounter any issues:
For contributors:
1. Fork the repository.
2. Create a feature branch.
3. Follow the [Development Guide](development/README.md) for contribution guidelines.
3. Follow the [Development Guide](development/development.md) for contribution guidelines.
4. Submit a pull request with your enhancements.
## Support