Add Knocki documentation

[joostlek]

Proposed change

Add Knocki documentation

Type of change

• Spelling, grammar or other readability improvements (current branch).
• Adjusted missing or incorrect information in the current documentation (current branch).
• Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • I've opened up a PR to add logos and icons in Brands repository.
• Added documentation for a new feature I'm adding to Home Assistant (next branch).
• Removed stale or deprecated documentation.

Additional information

• Link to parent pull request in the codebase: Add Knocki integration core#119140
• Link to parent pull request in the Brands repository: Add Knocki logos brands#5578
• This PR fixes or closes issue: fixes #

Checklist

• This PR uses the correct branch, based on one of the following:
  • I made a change to the existing documentation and used the current branch.
  • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
• The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

• Documentation
  • Added instructions on setting up Knocki devices in Home Assistant to receive events triggered by these devices.

[coderabbitai]

Walkthrough

Walkthrough

This update introduces instructions on setting up Knocki devices in Home Assistant, enabling the integration to receive events triggered by these devices. The changes are purely instructional and do not involve any modifications to the declarations of exported or public entities.

Changes

File	Change Summary
source/_integrations/knocki.markdown	Added guidance on configuring Knocki devices in Home Assistant to handle events triggered by these devices.

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between cf6baf1 and 3a7bbfb.

Files selected for processing (1)

• source/_integrations/knocki.markdown (1 hunks)

Additional context used

LanguageTool

source/_integrations/knocki.markdown

[misspelling] ~18-~18: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...ntegration_type: integration --- The Knocki {% term integration %} can receive ev...

---

[misspelling] ~18-~18: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...ents for the triggers set up from your Knocki devices. ## Prer...

---

[misspelling] ~22-~22: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...ki.com/). ## Prerequisites To use the Knocki integration, you need a Knocki account....

---

[misspelling] ~22-~22: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ... use the Knocki integration, you need a Knocki account. Once you set a trigger in the...

Additional comments not posted (3)

source/_integrations/knocki.markdown (3)

1-16: Metadata setup looks correct.

The metadata fields such as title, description, ha_category, and others are appropriately set up for the new integration documentation.

---

18-18: Introduction is clear and concise.

The introductory sentence effectively communicates the functionality of the Knocki integration. The term "Knocki" is correctly used here, and the apparent misspelling flagged by static analysis is a false positive.

Tools

LanguageTool

[misspelling] ~18-~18: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...ntegration_type: integration --- The Knocki {% term integration %} can receive ev...

---

[misspelling] ~18-~18: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...ents for the triggers set up from your Knocki devices. ## Prer...

---

20-24: Enhance clarity and grammar in the prerequisites section.

The prerequisites section can be made more concise and clear. There's also a hint about a possible missing comma which should be addressed to improve readability.

- To use the Knocki integration, you need a Knocki account.
+ To use the Knocki integration, you need a Knocki account.

Likely invalid or redundant comment.

Tools

LanguageTool

[misspelling] ~22-~22: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ...ki.com/). ## Prerequisites To use the Knocki integration, you need a Knocki account....

---

[misspelling] ~22-~22: Possible spelling mistake found. (MORFOLOGIK_RULE_EN_US)
Context: ... use the Knocki integration, you need a Knocki account. Once you set a trigger in the...

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[netlify]

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	3a7bbfb
🔍 Latest deploy log	https://app.netlify.com/sites/home-assistant-docs/deploys/6679141854e1920008061976
😎 Deploy Preview	https://deploy-preview-33256--home-assistant-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[c0ffeeca7]

Are there any prerequisites? For example: Do I need a Knocki account and login credentials when adding the integration?

[joostlek]

Usually I am a bit more verbal, but in this case I don't have a lot of words haha

[coderabbitai]

Actionable comments posted: 1

[c0ffeeca7]

Thank you, @joostlek 👍

[c0ffeeca7]

@joostlek, can you take a look at the related brand PR?

[frenck]

Pinged Joost about the brands, merging this one in to I can start working on rc.