Skip to content

Conversation

@JP-Ellis
Copy link
Contributor

@JP-Ellis JP-Ellis commented Dec 4, 2025

📝 Summary

This prevents warnings from going unnoticed.

🚨 Breaking Changes

🔥 Motivation

There was a recent update which broke our docs, and this went unnoticed due to the warnings not resulting in failure.

🔨 Test Plan

CI

🔗 Related issues/PRs

@JP-Ellis JP-Ellis self-assigned this Dec 4, 2025
Copilot AI review requested due to automatic review settings December 4, 2025 00:19
Copy link
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 adds strict mode to the documentation build process to ensure that warnings are treated as errors, preventing documentation issues from going unnoticed in CI.

Key changes:

  • Adds --strict flag to the mkdocs build command in the GitHub Actions workflow

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@codecov
Copy link

codecov bot commented Dec 4, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 51%. Comparing base (a7ac6a9) to head (250f205).
⚠️ Report is 1 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@         Coverage Diff          @@
##           main   #1382   +/-   ##
====================================
  Coverage    51%     51%           
====================================
  Files        31      31           
  Lines      3729    3729           
====================================
  Hits       1938    1938           
  Misses     1791    1791           
Flag Coverage Δ
tests 51% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

This prevents warnings from going unnoticed.

Signed-off-by: JP-Ellis <josh@jpellis.me>
@JP-Ellis JP-Ellis force-pushed the chore/use-strict-docs-building branch from 408cc9e to 250f205 Compare December 4, 2025 00:27
@JP-Ellis JP-Ellis merged commit c4bc3e5 into main Dec 4, 2025
59 checks passed
@JP-Ellis JP-Ellis deleted the chore/use-strict-docs-building branch December 4, 2025 00:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants