Skip to content

Conversation

@iMicknl
Copy link
Owner

@iMicknl iMicknl commented Jan 18, 2026

Enhancement

Fixes #190, #1522

Copilot AI review requested due to automatic review settings January 18, 2026 17:09
@iMicknl iMicknl requested a review from tetienne as a code owner January 18, 2026 17:09
Copy link
Contributor

Copilot AI left a 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.

@iMicknl iMicknl added the v2 label Jan 18, 2026
@iMicknl iMicknl added the enhancement New feature or request label Jan 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request v2

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants