13 Commits

Author SHA1 Message Date
Mike McQuaid
e3e8ccef0a
docs: fix HTML Proofer in CI
- Add caching to make this build faster and less flaky.
- Skip the currently flaky URL.
- Cache external links for longer.
2025-06-27 08:09:24 +01:00
Mike McQuaid
e5f844ec86
docs/Rakefile: fix/ignore more broken URLs. 2025-05-21 17:06:38 +01:00
Issy Long
00905fbd7e
Enforce that all docs have last_review_date frontmatter
- So we don't forget to add it to new docs we write.
2025-02-08 00:14:10 +00:00
Mike McQuaid
1b8bddd8bf
docs: brew style --fix 2024-06-13 09:55:31 +01:00
Mike McQuaid
faedd41dfb
docs: more workflow improvements.
- Add a special step to handle formulae.brew.sh API samples generation.
- Ignore the root URL: it always works and often is a false-positive
  failure.

While we're here:
- Autofix some RuboCop offenses in the Rakefile.
2024-06-11 13:53:16 +01:00
Mike McQuaid
c2bddc9957
docs/Rakefile: fix broken link.
This link works but it's failing CI.
2023-09-13 09:00:37 +01:00
Issy Long
484c7e07d1
Cache the external links for an hour, and ignore GitHub.com 2023-09-01 01:02:03 +01:00
Issy Long
17de29e93d
Disable HTMLProofer's assume_extension option
- It reports a lot of broken internal links that do actually exist, it's
  just file extension inference weirdness.
2023-09-01 01:02:02 +01:00
Issy Long
7f2ed15db3
Update html-proofer configuration - the parameter names changed 2023-09-01 01:01:57 +01:00
EricFromCanada
d9ef454528
CI: add docs.yml
With fixes for Markdown syntax to allow tests to pass.
2022-11-26 10:28:12 -05:00
EricFromCanada
45bf8b0118
docs: add mdl for Markdown linting
Run with `mdl -c docs/.mdlrc docs/*.md`.
2021-12-02 22:58:31 -05:00
Sean Molenaar
1d6159fe65
add https checking for links 2020-03-10 10:01:15 +01:00
Mike McQuaid
8a2490a1d3
docs: check links with html-proofer
This can be done with `bundle exec rake test`.
2018-10-04 15:37:01 +01:00