docs: document all registered built-in domains (#90)#97
Merged
Conversation
Add reference pages and MkDocs nav entries for the seven built-in domains that were registered but undocumented: air_quality, event, fan, humidifier, lock, vacuum, valve. Update the README and docs/index.md feature lists to enumerate all sixteen built-in domain accessors. Add tests/test_docs_completeness.py to prevent future drift between DomainRegistry and the documentation surface.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #90.
Issue validity
Valid and actionable. Verified by inspecting
src/haclient/domains/__init__.py: the package registers 16 built-in domains, but the README,docs/index.md, and the MkDocs nav listed only 9. Seven domains were undiscoverable from the docs:air_quality,event,fan,humidifier,lock,vacuum,valve.Fix
docs/reference/domains/{air_quality,event,fan,humidifier,lock,vacuum,valve}.mdreference pages (mkdocstrings auto-pages, matching the existing style).mkdocs.ymlto include all 16 built-in domains, alphabetised for stability.README.mdanddocs/index.mdto enumerate all built-in domain accessors.tests/test_docs_completeness.py— two regression tests that fail whenever a registered domain lacks either a Markdown reference page or a nav entry. This prevents the same drift from recurring.No source-code changes; documentation and a guard test only.
Checks run
ruff check src tests— passedruff format --check src tests— passedmypy src— passed (strict mode, 38 source files, no issues)pytest tests/ --cov=haclient --cov-report=term-missing --cov-fail-under=95— 328 passed, 97.18% coverage