Skip to content

Update docs v3#3046

Open
isabella200617 wants to merge 3 commits into
catchorg:develfrom
isabella200617:update-docs-v3
Open

Update docs v3#3046
isabella200617 wants to merge 3 commits into
catchorg:develfrom
isabella200617:update-docs-v3

Conversation

@isabella200617

Copy link
Copy Markdown

Description

This PR updates outdated documentation references for Catch2 v3 to ensure the documentation accurately reflects the current state of the project.

Changes made:

  • contributing.md: Clarified that v3 is the main development branch, removing outdated references to v2.x active maintenance
  • own-main.md: Fixed broken Clara documentation link to point to internal command-line documentation instead of archived external repository
  • migrate-v2-to-v3.md: Improved migration instructions to be less destructive (removing definitions vs deleting files)
  • release-notes.md: Updated outdated include references from catch.hpp to catch_all.hpp for v3 compatibility

These changes help users:

  • Understand the current development focus is on v3
  • Follow working documentation links
  • Successfully migrate from v2 to v3 without confusion
  • Use correct include paths in their projects

GitHub Issues

Addresses #2050

Isabella Garzón added 3 commits November 16, 2025 23:14
- 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

codecov Bot commented Nov 17, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 91.04%. Comparing base (a1faad9) to head (1068823).

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:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@rajpratham1 rajpratham1 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

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