-
Notifications
You must be signed in to change notification settings - Fork 34
Improve developer documentation #1908
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: v2/main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This pull request adds comprehensive developer documentation infrastructure and content to address issues #190 (automatic API documentation generation) and #1522 (device control examples).
Changes:
- Adds MkDocs documentation framework with Material theme, mkdocstrings for API reference generation, and automated GitHub Pages deployment
- Creates user guide documentation covering authentication, device control, event handling, error handling, and troubleshooting
- Adds contribution guidelines and developer setup instructions
Reviewed changes
Copilot reviewed 14 out of 20 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| pyproject.toml | Adds optional "docs" dependency group for MkDocs and related tools |
| uv.lock | Updates dependency lock file with documentation tool dependencies |
| mkdocs.yml | Configures MkDocs with Material theme and mkdocstrings plugin for API documentation |
| .github/workflows/docs.yml | Adds GitHub Actions workflow to build and deploy documentation to GitHub Pages |
| docs/*.md | Creates comprehensive user guides for getting started, authentication, core concepts, device control, event handling, error handling, troubleshooting, and contributing |
| docs/api-reference.md | Sets up automatic API documentation using mkdocstrings |
| docs/api/* | Contains legacy API documentation assets (CSS/JS) that appear unused |
| docs/callable_names.txt | Removes old callable names list (no longer needed with automatic documentation) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…oject description
…e getting started section
Enhancement
Fixes #190, #1522