Skip to content

AdGuard integration documentation improvements #39749

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 30, 2025
Merged

Conversation

frenck
Copy link
Member

@frenck frenck commented Jun 27, 2025

Proposed change

As per subject of this pull request. This PR adds more details to the AdGuard Home integration 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).
  • 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:
  • Link to parent pull request in the Brands repository:
  • 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
    • Expanded and restructured AdGuard Home integration documentation for improved clarity and completeness.
    • Added detailed setup instructions, configuration parameters, and descriptions of sensors and switches.
    • Enhanced actions section with consistent naming, detailed usage notes, and new information on the refresh action.
    • Included multiple example automations and a new data update section.
    • Expanded troubleshooting guidance and added a removal section.

@Copilot Copilot AI review requested due to automatic review settings June 27, 2025 16:15
@home-assistant home-assistant bot added the current This PR goes into the current branch label Jun 27, 2025
Copy link

netlify bot commented Jun 27, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 3cf0f0b
🔍 Latest deploy log https://app.netlify.com/projects/home-assistant-docs/deploys/68622a363df18a00082cede8
😎 Deploy Preview https://deploy-preview-39749--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Copy link
Contributor

@Copilot 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 PR enhances the AdGuard Home integration documentation by expanding setup instructions, adding detailed configuration options, and including practical examples and troubleshooting steps.

  • Added a “Prerequisites” section and detailed configuration parameters
  • Organized sensors, switches, actions, and examples into clear, structured sections
  • Improved troubleshooting guidance and included standard removal instructions
Comments suppressed due to low confidence (3)

source/_integrations/adguard.markdown:68

  • [nitpick] Inconsistent casing: use **Safe Browsing** (capital B) to match Home Assistant UI terminology.
- **Safe browsing**: Blocks known phishing and malware sites

source/_integrations/adguard.markdown:218

  • Imperative list items should end with a period. Add a period at the end of each step under “Resolution” for consistency and clarity.
   - Access the AdGuard Home web interface at `http://YOUR_IP:3000`

source/_integrations/adguard.markdown:12

  • The frontmatter has a duplicated and mis-indented code owner entry. Remove the extra - - '@frenck' so that only one properly indented - "@frenck" remains.
  - "@frenck"

Copy link
Contributor

coderabbitai bot commented Jun 27, 2025

📝 Walkthrough

Walkthrough

The AdGuard Home integration documentation was extensively rewritten and expanded. The introduction now better describes AdGuard Home’s functionality. New sections cover prerequisites, detailed configuration options, sensors, switches with explicit behaviors, and a renamed actions section with consistent action naming and parameters. Example automations, data update intervals, troubleshooting, and removal instructions were added for completeness.

Changes

File(s) Change Summary
source/_integrations/adguard.markdown Complete rewrite and expansion of documentation: improved introduction; added prerequisites; detailed configuration, sensors, switches, and actions sections with consistent naming; included example automations; expanded data update and troubleshooting content; added removal instructions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HomeAssistant
    participant AdGuardHome

    User->>HomeAssistant: Configure AdGuard Home integration (host, port, credentials)
    HomeAssistant->>AdGuardHome: Establish connection
    HomeAssistant->>AdGuardHome: Poll status and statistics (every 10s)
    AdGuardHome-->>HomeAssistant: Return sensor and switch data
    User->>HomeAssistant: Trigger action (e.g., adguard.add_url)
    HomeAssistant->>AdGuardHome: Perform requested action
    AdGuardHome-->>HomeAssistant: Confirm action result
    HomeAssistant-->>User: Update sensors, switches, and notify as configured
Loading

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 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>, please review it.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 using 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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🔭 Outside diff range comments (1)
source/_integrations/adguard.markdown (1)

47-61: Section title deviates from the integration-docs template

## Supported functionality isn’t part of the standard section ordering (Configuration → Entities → Services → Automations/Examples → Troubleshooting → Removing).
Rename to ## Entities (or split into ## Sensors / ## Switches as top-level), otherwise the docs build will flag the structure.

♻️ Duplicate comments (1)
source/_integrations/adguard.markdown (1)

240-242: Second terminology violation – “ads”

Same text-lint error as earlier; replace with “ADS” to satisfy CI.

-error occurs when trying to enable, disable, or remove a non-existent filter URL.
+error occurs when trying to enable, disable, or remove a non-existent filter URL.

(And swap “ads” in previous sentence.)

🧹 Nitpick comments (1)
source/_integrations/adguard.markdown (1)

202-205: Polling interval statement duplicates header metadata

The front-matter already defines ha_iot_class: Local Polling. If you keep the “Data updates” section, ensure wording matches “polling every 10 seconds” and justify the override (default poll interval is usually 30 s). Otherwise this may confuse readers.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between b0c8777 and 623e447.

📒 Files selected for processing (1)
  • source/_integrations/adguard.markdown (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`source/_integrations/*`: Integration documentation must use the provided template structure and section order.

source/_integrations/*: Integration documentation must use the provided template structure and section order.

📄 Source: CodeRabbit Inference Engine (.github/copilot-instructions.md)

List of files the instruction was applied to:

  • source/_integrations/adguard.markdown
🪛 LanguageTool
source/_integrations/adguard.markdown

[uncategorized] ~218-~218: The preposition ‘to’ seems more likely in this position.
Context: ...- Access the AdGuard Home web interface at http://YOUR_IP:3000 - Check the se...

(AI_HYDRA_LEO_REPLACE_AT_TO)

🪛 GitHub Actions: home-assistant.io Test
source/_integrations/adguard.markdown

[error] 22-22: textlint: Incorrect term: “ads”, use “ADS” instead (terminology)


[error] 242-242: textlint: Incorrect term: “ads”, use “ADS” instead (terminology)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - home-assistant-docs
  • GitHub Check: Header rules - home-assistant-docs
  • GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (1)
source/_integrations/adguard.markdown (1)

62-79: Macro misuse & glossary consistency

  1. {% term polls %} (l. 204) is not a defined glossary term; the correct one is {% term polling %}.
  2. Verify {% important %} block placement – it must be closed before starting a new heading; current placement is fine but double-check when moving sections per previous comment.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

♻️ Duplicate comments (6)
source/_integrations/adguard.markdown (6)

22-23: Terminology violation – replace “ads” with the canonical “ADS”

The docs linter (see pipeline failure) requires the uppercase glossary term.

-AdGuard Home is a network-wide software for blocking ads and tracking.
+AdGuard Home is a network-wide software for blocking ADS and tracking.

81-90: Section heading must use “Services”, not “Actions”

Per HA docs conventions, these are Home-Assistant services. Rename the main heading and adjust the explanatory paragraph accordingly:

-## Actions
-
-The integration provides {% term actions %} to manage filter subscriptions …
+## Services
+
+The integration provides {% term services %} to manage filter subscriptions …

(The same terminology fix is required for every subheading ### Action … below.)
This was already flagged in the previous review but hasn’t been addressed.


91-131: Rename all sub-headings from “Action” → “Service”

Apply the following mechanical replacement:

-### Action `adguard.add_url`
+### Service `adguard.add_url`-### Action `adguard.remove_url`
+### Service `adguard.remove_url`-### Action `adguard.enable_url`
+### Service `adguard.enable_url`-### Action `adguard.disable_url`
+### Service `adguard.disable_url`-### Action `adguard.refresh`
+### Service `adguard.refresh`

Ensures discoverability in the autogenerated services index.


140-161: Automation examples use invalid keys (triggers/actions) → will not load

Home Assistant automations require trigger: (singular) and action: with service: …. Suggested fix:

automation:
   - alias: "Block social media during work"
-    triggers:
-      - trigger: time
-        at: "09:00:00"
-    actions:
-      - action: adguard.add_url
+    trigger:
+      - platform: time
+        at: "09:00:00"
+    action:
+      - service: adguard.add_url
         data:
           name: "Social media blocklist"
           url: "https://raw.githubusercontent.com/example/social-media-blocklist/main/list.txt"
-      - action: adguard.refresh
+      - service: adguard.refresh

Apply the same pattern to lines 153-161.
Broken examples confuse users and fail copy-paste testing.


167-182: Invalid automation syntax replicated – fix triggers/actions

Repeat the corrections:

-    triggers:
-      - trigger: state
+    trigger:
+      - platform: state
         entity_id: group.guest_devices
         from: "not_home"
         to: "home"
-    actions:
-      - action: switch.turn_on
+    action:
+      - service: switch.turn_on

Also ensure the block is wrapped in {% raw %} if needed for Jinja.


191-201: Third example still uses invalid keys – correct for consistency

-      - trigger: numeric_state
+      - platform: numeric_state
         entity_id: sensor.adguard_average_processing_speed
         above: 50
-    actions:
-      - action: notify.mobile_app
+    action:
+      - service: notify.mobile_app

Without this, newcomers will face immediate YAML validation errors.

🧹 Nitpick comments (1)
source/_integrations/adguard.markdown (1)

206-206: Style nit – remove double blank line (MD012)

Markdown-lint flags the extra blank line after {% endraw %}.
Delete one of the consecutive blank lines to satisfy the linter.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 623e447 and a4f6b0f.

📒 Files selected for processing (1)
  • source/_integrations/adguard.markdown (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`source/_integrations/*`: Integration documentation must use the provided template structure and section order.

source/_integrations/*: Integration documentation must use the provided template structure and section order.

📄 Source: CodeRabbit Inference Engine (.github/copilot-instructions.md)

List of files the instruction was applied to:

  • source/_integrations/adguard.markdown
🪛 LanguageTool
source/_integrations/adguard.markdown

[uncategorized] ~38-~38: A determiner appears to be missing. Consider inserting it.
Context: ...: "The port AdGuard Home is running on. Default is 3000 for the web interface." Usern...

(AI_EN_LECTOR_MISSING_DETERMINER)


[uncategorized] ~105-~105: A punctuation mark might be missing here.
Context: ...| ------------------------------------- | | url | No | The filte...

(AI_EN_LECTOR_MISSING_PUNCTUATION)


[uncategorized] ~113-~113: A punctuation mark might be missing here.
Context: ...| ------------------------------------- | | url | No | The filte...

(AI_EN_LECTOR_MISSING_PUNCTUATION)


[uncategorized] ~223-~223: The preposition ‘to’ seems more likely in this position.
Context: ...- Access the AdGuard Home web interface at http://YOUR_IP:3000 - Check the se...

(AI_HYDRA_LEO_REPLACE_AT_TO)

🪛 markdownlint-cli2 (0.17.2)
source/_integrations/adguard.markdown

206-206: Multiple consecutive blank lines
Expected: 1; Actual: 2

(MD012, no-multiple-blanks)

🪛 GitHub Actions: home-assistant.io Test
source/_integrations/adguard.markdown

[error] 22-22: textlint: Incorrect term: “ads”, use “ADS” instead (terminology)


[error] 242-242: textlint: Incorrect term: “ads”, use “ADS” instead (terminology)

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

♻️ Duplicate comments (5)
source/_integrations/adguard.markdown (5)

22-23: Replace lowercase “ads” with glossary-approved “ADS”.

The docs linter is still failing (Incorrect term: “ads”) on this sentence. Use the canonical uppercase term.

-AdGuard Home is a network-wide software for blocking ads and tracking.
+AdGuard Home is a network-wide software for blocking ADS and tracking.

81-84: Rename “Actions” heading & references to “Services”.

Home Assistant exposes these as services (adguard.add_url, …). Keeping the wrong term breaks discoverability in the generated Services index.

-## Actions
-The integration provides {% term actions %} to manage ...
+## Services
+The integration provides {% term services %} to manage ...

Remember to update all sub-headings (### Service \adguard.add_url`` …) and internal links.


140-152: Automation example uses invalid keys (triggers, actions).

YAML won’t load in HA. Correct structure:

 automation:
   - alias: "Block social media during work"
-    triggers:
-      - trigger: time
+    trigger:
+      - platform: time
         at: "09:00:00"
-    actions:
-      - action: adguard.add_url
+    action:
+      - service: adguard.add_url
         data:
           name: "Social media blocklist"
           url: "https://raw.githubusercontent.com/example/social-media-blocklist/main/list.txt"
-      - action: adguard.refresh
+      - service: adguard.refresh

Apply the same pattern to the “Unblock” automation below.


168-182: Invalid automation syntax repeated – fix triggerstrigger, actionsaction.

 automation:
   - alias: "Enable strict filtering for guests"
-    triggers:
-      - trigger: state
+    trigger:
+      - platform: state
         entity_id: group.guest_devices
         from: "not_home"
         to: "home"
-    actions:
-      - action: switch.turn_on
+    action:
+      - service: switch.turn_on
         target:
           entity_id:
             - switch.adguard_parental_control
             - switch.adguard_safe_browsing
             - switch.adguard_safe_search

190-201: Third example still uses incorrect keys and should live inside {% raw %}.

-{% raw %}
-
 automation:
   - alias: "Alert on slow DNS"
-    triggers:
-      - trigger: numeric_state
+    trigger:
+      - platform: numeric_state
         entity_id: sensor.adguard_average_processing_speed
         above: 50
-    actions:
-      - action: notify.mobile_app
+    action:
+      - service: notify.mobile_app
         data:
           title: "DNS Performance Alert"
           message: "AdGuard DNS response time is {{ states('sensor.adguard_average_processing_speed') }}ms"
-
-{% endraw %}

Enclose the block in {% raw %} … {% endraw %} to avoid Jinja evaluation.

🧹 Nitpick comments (2)
source/_integrations/adguard.markdown (2)

34-40: Minor wording improvement – missing determiner.

-  description: "The port AdGuard Home is running on. Default is `3000` for the web interface."
+  description: "The port that AdGuard Home is running on. Default is `3000` for the web interface."

204-206: Remove extra blank line – violates MD012 (no-multiple-blanks).

-
-
 {% endraw %}
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between a4f6b0f and 0c2a38f.

📒 Files selected for processing (1)
  • source/_integrations/adguard.markdown (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`source/_integrations/*`: Integration documentation must use the provided template structure and section order.

source/_integrations/*: Integration documentation must use the provided template structure and section order.

📄 Source: CodeRabbit Inference Engine (.github/copilot-instructions.md)

List of files the instruction was applied to:

  • source/_integrations/adguard.markdown
🪛 LanguageTool
source/_integrations/adguard.markdown

[uncategorized] ~38-~38: A determiner appears to be missing. Consider inserting it.
Context: ...: "The port AdGuard Home is running on. Default is 3000 for the web interface." Usern...

(AI_EN_LECTOR_MISSING_DETERMINER)


[uncategorized] ~105-~105: A punctuation mark might be missing here.
Context: ...| ------------------------------------- | | url | No | The filte...

(AI_EN_LECTOR_MISSING_PUNCTUATION)


[uncategorized] ~113-~113: A punctuation mark might be missing here.
Context: ...| ------------------------------------- | | url | No | The filte...

(AI_EN_LECTOR_MISSING_PUNCTUATION)


[uncategorized] ~223-~223: The preposition ‘to’ seems more likely in this position.
Context: ...- Access the AdGuard Home web interface at http://YOUR_IP:3000 - Check the se...

(AI_HYDRA_LEO_REPLACE_AT_TO)

🪛 markdownlint-cli2 (0.17.2)
source/_integrations/adguard.markdown

206-206: Multiple consecutive blank lines
Expected: 1; Actual: 2

(MD012, no-multiple-blanks)

🪛 GitHub Actions: home-assistant.io Test
source/_integrations/adguard.markdown

[error] 22-22: textlint: Incorrect term: “ads”, use “ADS” instead (terminology)


[error] 242-242: textlint: Incorrect term: “ads”, use “ADS” instead (terminology)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - home-assistant-docs
  • GitHub Check: Header rules - home-assistant-docs
  • GitHub Check: Pages changed - home-assistant-docs

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

♻️ Duplicate comments (4)
source/_integrations/adguard.markdown (4)

81-85: Rename “Actions” section to “Services” to align with Home Assistant terminology
The documented features (adguard.add_url, etc.) are exposed as Home Assistant services, not “actions”. Keeping the wrong term breaks discoverability in the generated Services index.

-## Actions
+## Services
@@
-The integration provides {% term actions %} to manage filter subscriptions…
+The integration provides {% term services %} to manage filter subscriptions…

Please also update every sub-heading (### Action …) and any in-text references to use Service instead of Action.


140-161: Automation examples use invalid YAML keys (triggers, actions, action:)
The samples won’t load in HA because the automation schema expects the singular keys trigger and action, and service calls must be declared with the service key:

 automation:
   - alias: "Block social media during work"
-    triggers:
-      - trigger: time
+    trigger:
+      - platform: time
         at: "09:00:00"
-    actions:
-      - action: adguard.add_url
+    action:
+      - service: adguard.add_url
         data:
@@
-      - action: adguard.refresh
+      - service: adguard.refresh
@@
   - alias: "Unblock social media after work"
-    triggers:
-      - trigger: time
+    trigger:
+      - platform: time
         at: "17:00:00"
-    actions:
-      - action: adguard.remove_url
+    action:
+      - service: adguard.remove_url

Apply similar corrections to the subsequent YAML blocks (lines 168-182 and 190-201).


168-182: Repeat of invalid automation syntax — please apply the same fix
This block still uses triggers/actions and calls switch.turn_on via action: instead of service:. Update as shown in the previous comment to prevent config-check failures.


190-201: Third occurrence of incorrect automation keys
The notification example follows the same invalid pattern (triggers, actions, action:). Replace with trigger, action, and service respectively.

🧹 Nitpick comments (2)
source/_integrations/adguard.markdown (2)

36-38: Minor wording nit – insert definite article for clarity

-  description: "The port AdGuard Home is running on. Default is `3000` for the web interface."
+  description: "The port that AdGuard Home is running on. Default is `3000` for the web interface."

204-208: Remove extra blank line to satisfy markdownlint (MD012)

-{% endraw %}
-
+{% endraw %}
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 0c2a38f and 989ebbb.

📒 Files selected for processing (1)
  • source/_integrations/adguard.markdown (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`source/_integrations/*`: Integration documentation must use the provided template structure and section order.

source/_integrations/*: Integration documentation must use the provided template structure and section order.

📄 Source: CodeRabbit Inference Engine (.github/copilot-instructions.md)

List of files the instruction was applied to:

  • source/_integrations/adguard.markdown
🪛 LanguageTool
source/_integrations/adguard.markdown

[uncategorized] ~38-~38: A determiner appears to be missing. Consider inserting it.
Context: ...: "The port AdGuard Home is running on. Default is 3000 for the web interface." Usern...

(AI_EN_LECTOR_MISSING_DETERMINER)


[uncategorized] ~105-~105: A punctuation mark might be missing here.
Context: ...| ------------------------------------- | | url | No | The filte...

(AI_EN_LECTOR_MISSING_PUNCTUATION)


[uncategorized] ~113-~113: A punctuation mark might be missing here.
Context: ...| ------------------------------------- | | url | No | The filte...

(AI_EN_LECTOR_MISSING_PUNCTUATION)


[uncategorized] ~223-~223: The preposition ‘to’ seems more likely in this position.
Context: ...- Access the AdGuard Home web interface at http://YOUR_IP:3000 - Check the se...

(AI_HYDRA_LEO_REPLACE_AT_TO)

🪛 markdownlint-cli2 (0.17.2)
source/_integrations/adguard.markdown

206-206: Multiple consecutive blank lines
Expected: 1; Actual: 2

(MD012, no-multiple-blanks)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - home-assistant-docs
  • GitHub Check: Header rules - home-assistant-docs
  • GitHub Check: Pages changed - home-assistant-docs

Copy link
Contributor

@c0ffeeca7 c0ffeeca7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, @frenck 👍

@c0ffeeca7 c0ffeeca7 enabled auto-merge (squash) June 30, 2025 06:10
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

♻️ Duplicate comments (3)
source/_integrations/adguard.markdown (3)

81-81: Heading must use “Services”, not “Actions”

Home Assistant documentation indexes integration ​services​ under the “Services” heading. Keeping “Actions” breaks discoverability and contradicts HA terminology.

-## Actions
+## Services

91-132: Rename every sub-heading & wording from “Action” ➜ “Service”

After renaming the main heading, each sub-section must follow the same convention, e.g.:

-### Action `adguard.add_url`
+### Service `adguard.add_url`

Apply to remove_url, enable_url, disable_url, and refresh.
This keeps the docs consistent with the generated services index and prevents broken links.


140-161: Automation YAML examples use invalid keys (triggers, actions, action:)

The Home Assistant automation schema expects singular trigger, action, and service, not the plural forms or action: shortcut. These examples will not load in UI or core.

Example fix for the first block:

-automation:
-  - alias: "Block social media during work"
-    triggers:
-      - trigger: time
-        at: "09:00:00"
-    actions:
-      - action: adguard.add_url
+automation:
+  - alias: "Block social media during work"
+    trigger:
+      - platform: time
+        at: "09:00:00"
+    action:
+      - service: adguard.add_url
         data:
           name: "Social media blocklist"
           url: "https://raw.githubusercontent.com/example/social-media-blocklist/main/list.txt"
-      - action: adguard.refresh
+      - service: adguard.refresh

Apply the same corrections to the two other sample blocks (guest filtering & DNS performance).

Also applies to: 168-182, 191-201

🧹 Nitpick comments (1)
source/_integrations/adguard.markdown (1)

204-207: Remove doubled blank line to satisfy markdownlint (MD012)

Markdown style requires a single blank line between sections.

-{% endraw %}
-
-
+{% endraw %}
+
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 989ebbb and 3cf0f0b.

📒 Files selected for processing (1)
  • source/_integrations/adguard.markdown (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`source/_integrations/*`: Integration documentation must use the provided template structure and section order.

source/_integrations/*: Integration documentation must use the provided template structure and section order.

📄 Source: CodeRabbit Inference Engine (.github/copilot-instructions.md)

List of files the instruction was applied to:

  • source/_integrations/adguard.markdown
🪛 LanguageTool
source/_integrations/adguard.markdown

[uncategorized] ~38-~38: A determiner appears to be missing. Consider inserting it.
Context: ...: "The port AdGuard Home is running on. Default is 3000 for the web interface." Usern...

(AI_EN_LECTOR_MISSING_DETERMINER)


[uncategorized] ~105-~105: A punctuation mark might be missing here.
Context: ...| ------------------------------------- | | url | No | The filte...

(AI_EN_LECTOR_MISSING_PUNCTUATION)


[uncategorized] ~113-~113: A punctuation mark might be missing here.
Context: ...| ------------------------------------- | | url | No | The filte...

(AI_EN_LECTOR_MISSING_PUNCTUATION)


[uncategorized] ~241-~241: You might be missing the article “a” here.
Context: ...t least one device uses AdGuard Home as DNS server. ### Actions fail with "Filter ...

(AI_EN_LECTOR_MISSING_DETERMINER_A)

🪛 markdownlint-cli2 (0.17.2)
source/_integrations/adguard.markdown

206-206: Multiple consecutive blank lines
Expected: 1; Actual: 2

(MD012, no-multiple-blanks)

⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Redirect rules - home-assistant-docs
  • GitHub Check: Header rules - home-assistant-docs
  • GitHub Check: Pages changed - home-assistant-docs
  • GitHub Check: Lint Markdown

@frenck frenck disabled auto-merge June 30, 2025 08:53
@frenck frenck merged commit fd6a816 into current Jun 30, 2025
9 checks passed
@frenck frenck deleted the frenck-2025-0331 branch June 30, 2025 08:54
@github-actions github-actions bot locked and limited conversation to collaborators Jul 1, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
current This PR goes into the current branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants