Improve troubleshooting links in FRITZ!Tools#42367
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
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-diagnosticsto#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. |
There was a problem hiding this comment.
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.
Proposed change
This points to the generell troubleshooting tips for debug logging and downloading the diagnostics data.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.