docs: align README, CODE_STYLE and CLAUDE.md with the actual codebase - #71
Merged
Conversation
The README undersold the integration (three entities, no binary sensor) and announced event attributes, a flat data.py, a TtlockBleOperationEvent class and lint/tests/validate workflows that do not exist. The entity table now lists the four real entities and the real log-event attributes, the layout matches the data/ package, and the CI section describes ci.yml, codeql.yml, release.yml and auto-assign.yml. CODE_STYLE.md and CLAUDE.md drop the same stale names and a config_flow._validate helper that never existed here, and describe the local uv run pre-commit hooks.
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.
Summary
The docs had drifted from the code in several places and were actively misleading:
lock_state/record_idattributes that do not exist. The table now lists the four real entities and the event section documents the real attributes (record_type,battery,timestamp,uid,credential,key_id,accessory_battery) and event types, including the passcode-redaction rule forcredential.data.py(real:data/package, one class per file) and aTtlockBleOperationEventclass (real:TtlockBleLogEvent);binary_sensor.pywas missing.lint.yml/tests.yml/validate.yml, none of which exist — the real workflows areci.yml(lint + tests + validate via the shared reusable workflows),codeql.yml,release.ymlandauto-assign.yml.config_flow._validatehelper that never existed here (input validation lives inmanual_key.async_validate); the pre-commit section now describes the localuv runhooks.first_refresh, and the architecture sketch referencedLockEventpushes instead of theLogEntryrecords the event platform actually surfaces.Documentation for the tooling described here lands with #69 (
scripts/setupvia uv, local pre-commit hooks); merge that one first.No code changes.