Skip to content

Improve troubleshooting links in FRITZ!Tools#42367

Merged
c0ffeeca7 merged 1 commit into
currentfrom
fritz/improve-troubleshooting-links
Dec 9, 2025
Merged

Improve troubleshooting links in FRITZ!Tools#42367
c0ffeeca7 merged 1 commit into
currentfrom
fritz/improve-troubleshooting-links

Conversation

@mib1185
Copy link
Copy Markdown
Member

@mib1185 mib1185 commented Dec 7, 2025

Proposed change

This points to the generell troubleshooting tips for debug logging and downloading the diagnostics data.

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.

Copilot AI review requested due to automatic review settings December 7, 2025 10:28
@mib1185 mib1185 requested a review from chemelli74 as a code owner December 7, 2025 10:28
@home-assistant home-assistant Bot added the current This PR goes into the current branch label Dec 7, 2025
@netlify
Copy link
Copy Markdown

netlify Bot commented Dec 7, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 9416811
🔍 Latest deploy log https://app.netlify.com/projects/home-assistant-docs/deploys/693556e6d1e8b300085397e7
😎 Deploy Preview https://deploy-preview-42367--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
Copy Markdown
Contributor

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 updates the troubleshooting section links in the FRITZ!Tools integration documentation to point to more specific anchor links in the troubleshooting guide. While the new links are technically valid, the change deviates from established documentation patterns used across most other integration files and removes the use of a glossary term reference.

Key changes

  • Updated debug logging link from #debug-logs-and-diagnostics to #enabling-debug-logging
  • Replaced glossary term {% term diagnostics %} with a regular link to #download-diagnostics

## Troubleshooting

In any case, when reporting an issue, please enable [debug logging](/docs/configuration/troubleshooting/#debug-logs-and-diagnostics), restart the integration, and as soon as the issue re-occurs stop the debug logging again (_download of debug log file will start automatically_). Further _if still possible_, please also download the {% term diagnostics %} data. If you have collected the debug log and the diagnostics data, provide them with the issue report.
In any case, when reporting an issue, please enable [debug logging](/docs/configuration/troubleshooting/#enabling-debug-logging), restart the integration, and as soon as the issue re-occurs stop the debug logging again (_download of debug log file will start automatically_). Further _if still possible_, please also download the [diagnostics data](/docs/configuration/troubleshooting/#download-diagnostics). If you have collected the debug log and the diagnostics data, provide them with the issue report.
Copy link

Copilot AI Dec 7, 2025

Choose a reason for hiding this comment

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

The change removes the use of the glossary term {% term diagnostics %} and replaces it with a regular link [diagnostics data](/docs/configuration/troubleshooting/#download-diagnostics). According to the documentation guidelines, glossary term references should be used when appropriate as they provide tooltips with term definitions for better user experience.

Additionally, most other integration files use a more common pattern:

  • For debug logging: /docs/configuration/troubleshooting/#debug-logs-and-diagnostics
  • For diagnostics: either [diagnostics](/integrations/diagnostics) or {% term diagnostics %}

Consider using one of these established patterns for consistency with the rest of the documentation. For example:

In any case, when reporting an issue, please enable [debug logging](/docs/configuration/troubleshooting/#debug-logs-and-diagnostics), restart the integration, and as soon as the issue re-occurs stop the debug logging again (_download of debug log file will start automatically_). Further _if still possible_, please also download the {% term diagnostics %} data. If you have collected the debug log and the diagnostics data, provide them with the issue report.

Copilot generated this review using guidance from repository custom instructions.
Copy link
Copy Markdown
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.

Nice! Thank you, @mib1185 👍

@c0ffeeca7 c0ffeeca7 merged commit e07e44d into current Dec 9, 2025
15 checks passed
@c0ffeeca7 c0ffeeca7 deleted the fritz/improve-troubleshooting-links branch December 9, 2025 05:41
@github-actions github-actions Bot locked and limited conversation to collaborators Dec 10, 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.

3 participants