Try new validations in mkdocs `1.6.0` (after upgrading `mkdocs-material`)

HonkingGoose commented 5 months ago

What would you like to be able to do?

mkdocs 1.6.0 can warn us about broken absolute links and broken anchors in links (#anchor). I would definitely like to try these new warnings on our docs, to help catch broken stuff before creating a new build of the docs.

But mkdocs-material does not support mkdocs 1.6.0 yet. So we need to wait for a version of mkdocs-material that support the new mkdocs.

Did you already have any implementation ideas?

Here's a list of todos:

[x] Upgrade to a version of mkdocs-material that supports mkdocs 1.6.0
[x] Read the mkdocs 1.6.0 changelog to check for important changes
[x] Update to mkdocs 1.6.0
[x] Try the new options for validation of hyperlinks between pages:
- [x] validate absolute links I think we should keep this set to absolute_links: warn so we're "forced" to use relative links.
- [x] validate anchors in links
- [x] Read the MkDocs validation section and try the recommended settings for most sites (maximal strictness):
```
validation:
omitted_files: warn
absolute_links: warn  # Or 'relative_to_docs' - new in MkDocs 1.6
unrecognized_links: warn
anchors: warn  # New in MkDocs 1.6
```

I'm willing to try configuring the new settings for us, and helping to update. :smile:

Do you want to write this feature yourself?

Yes

squidfunk commented 5 months ago

Happy to collaborate on the 1.6 transition! Former minor version MkDocs releases sometimes broke parts of Material for MkDocs, which is why we decided to be a little more selective about what version we support. I currently have other things on my plate, but if you'd like to collaborate on a PR to bring Material for MkDocs and Insiders to 1.6, I'm happy to help wherever I can. Reading the release notes of 1.6, I think it should be pretty straight forward to support.

viceice commented 5 months ago

now ready, see #451

viceice commented 5 months ago

when https://github.com/renovatebot/renovate/pull/28690 is merged and updated here, then we should be able to enable additional warnings

renovatebot / renovatebot.github.io