docs: Fix broken ref links #4366
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Spotted a bad ref link (specifically the MD052 rule, we use "full" ref links), used a linter to search for any others and fixed those too.
Using linters on markdown aren't entirely reliable for our docs due to non-standard mkdocs syntax, notably admonitions not being recognized (thus indented content is treated as code blocks which causes false-positives such as with MD053 for detecting unused ref links).
Additionally added a note about false-positives when we have anchor links directly referencing
admonitionscontent tabs:The non-standard syntax doesn't allow us to add anchors (normally this can be done via mkdocs feature
{ #anchor-name }), and I think part of this false-positive is due to support implemented in mkdocs-material via an mkdocs extension.