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

36
docs/contributing.md Normal file
View File

@@ -0,0 +1,36 @@
# Contributing to Home Assistant MCP
We welcome contributions from the community! Your help and feedback are essential to improving the MCP Server. Please review the following guidelines before contributing.
## How to Contribute
1. **Fork the Repository**: Create your personal fork of the project on GitHub.
2. **Create a Feature Branch**: Use clear branch names, e.g., `feature/your-feature` or `bugfix/short-description`.
3. **Make Changes**: Develop your feature or fix bugs. Ensure your code follows the project's coding conventions.
4. **Write Tests**: Include tests for new features or bug fixes. We aim for high code coverage.
5. **Submit a Pull Request (PR)**: Once your changes are complete, submit a PR. Our team will review your request and provide feedback.
6. **Address Feedback**: Make any necessary revisions based on code review feedback.
## Code Style Guidelines
- Follow the project's established coding style.
- Use Bun tooling for linting and formatting:
- `bun run lint` for linting
- `bun run format` for formatting
## Documentation
- Update relevant documentation alongside your code changes.
- Ensure that tests pass and coverage remains high.
## Reporting Issues
- Use the GitHub Issues page to report bugs, request new features, or ask questions.
- Provide clear descriptions, replication steps, and any error logs.
## Community
- Join our real-time discussions on our chat platforms (Discord, Slack, etc.).
- Engage with other contributors to exchange ideas and solutions.
Thank you for helping improve the Home Assistant MCP project!