Skip to content

ISSUE: Wiki needs updating badly #535

@KlfJoat

Description

@KlfJoat

Describe the bug

The wiki is woefully out of date.

Examples:

https://github.com/FutureTense/keymaster/wiki/Pre-Installation-Steps-(IMPORTANT)

  • The packages folder is blank on my 2025.12 version of Home Assistant.
  • I removed these fields and Keymaster 0.1.1 works just fine without it

https://github.com/FutureTense/keymaster/wiki/Usage

  • I believe that the heavy use of binary_sensor templates is gone with v0.1.1
  • PIN Status is no longer a field in the generated Lovelace
  • There is nothing here (the page I'd expect it to be on) about the lock-specific (not PIN-specific) features of Keymaster. For example, what does "Retry Lock" do in conjunction with "Auto Lock"? Where does it actually explain "Auto Lock"?
  • What about the current meanings of "Synced", "Disconnected", "Deleting", etc?

These kinds of obvious issues makes me wonder how much of the rest of the wiki or even the README is valid.

Home Assistant itself makes documentation update a required part of any feature addition, breaking change, behavior modification, etc. It would be great if the system that coordinates access control to my house had up-to-date documentation.

I'm willing to help but I'm not sure of what is INTENDED in most of these cases. For example, what should "Retry Lock" do? And I don't understand Python code well enough to suss it out. If there is a spec, that would be great to build documentation around, but only if it's up to date. If someone can give me a run-down, I'd be glad to try to update the Wiki.

Environment (please complete the following information):

Irrelevant

Logs
Irrelevant

Screenshots
URLs above are sufficient, otherwise I'd be screenshotting and circling all of the content in the pages.

Additional context

Nope

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions