Feature/documentation cleanup #228
Conversation
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Type: Documentation
PR Summary: This PR introduces updates to the documentation and build notes to reflect the support for Catch2v2 and the integration of CPM as a package manager for handling dependencies. It includes changes to the CMake integration guide to accommodate the new version of Catch2 and introduces CPM for more efficient dependency management. The changes aim to improve the project's build process by offering more options for dependency management and ensuring compatibility with the latest version of Catch2.
Decision: Comment
📝 Type: 'Documentation' - not supported yet.
- Sourcery currently only approves 'Typo fix' PRs.
✅ Issue addressed: this change correctly addresses the issue or implements the desired feature.
No details provided.
📝 Complexity: the changes are too large or complex for Sourcery to approve.
- Unsupported files: the diff contains files that Sourcery does not currently support during reviews.
General suggestions:
- Ensure that all instances where Catch2 is mentioned are updated to reflect the move to Catch2v2 to maintain consistency across the documentation.
- Consider adding a brief section on migrating from Catch2 to Catch2v2 for users who might be directly affected by this change.
- It might be beneficial to include examples or more detailed instructions on how to use CPM for dependency management, especially for users who are not familiar with it.
Thanks for using Sourcery. We offer it for free for open source projects and would be very grateful if you could help us grow. If you like it, would you consider sharing Sourcery on your favourite social media? ✨
This PR was done pairing in support for catch2 v3