Update docs v3 - #3046
Conversation
- Clarify that v2.x is in maintenance mode only - Remove implication of active v2.x development Addresses catchorg#2050
- Clarify 'Delete TU' instruction to be less destructive - Emphasize removing definitions rather than deleting files Addresses catchorg#2050
- Update catch.hpp references to catch_all.hpp for v3 compatibility - Ensure historical documentation reflects current include structure Addresses catchorg#2050
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## devel #3046 +/- ##
=======================================
Coverage 91.04% 91.04%
=======================================
Files 202 202
Lines 8716 8716
=======================================
Hits 7935 7935
Misses 781 781 🚀 New features to boost your workflow:
|
rajpratham1
left a comment
There was a problem hiding this comment.
Thanks for updating the v3 documentation. The changes to contributing.md and migrate-v2-to-v3.md improve clarity. However, I'm hesitant about modifying docs/release-notes.md. Release notes are a historical record of what was true when that version shipped, so replacing historical references like #include <catch2/catch.hpp> with #include <catch2/catch_all.hpp> changes that record rather than documenting the current recommendation. I'd suggest keeping the release notes historically accurate and updating the migration or reference documentation instead.
Description
This PR updates outdated documentation references for Catch2 v3 to ensure the documentation accurately reflects the current state of the project.
Changes made:
These changes help users:
GitHub Issues
Addresses #2050