Update README.md and README.md-linked headline docs#1664
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1664 +/- ##
============================================
+ Coverage 99.29% 99.53% +0.23%
Complexity 920 920
============================================
Files 190 190
Lines 2141 2147 +6
============================================
+ Hits 2126 2137 +11
+ Misses 15 10 -5 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
This PR updates the main README and docs index to reflect current exception-handling capabilities and removes an outdated “concrete API” document that no longer matches recommended usage.
Changes:
- Replace the outdated “granularity control for advanced reporting” phrasing with “Advanced exception handling” in README and docs index.
- Adjust links in README and docs index related to exception handling and validators.
- Remove
docs/concrete-api.md, which described a non-recommended API usage pattern.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/index.md | Updates marketing bullets to emphasize advanced exception handling and validator count, but introduces incorrect relative link paths that need fixing. |
| docs/concrete-api.md | Fully removes the outdated concrete API documentation that no longer reflects recommended practices. |
| README.md | Updates top-level feature bullets to reflect current exception handling capabilities and removes the link to the removed concrete API doc. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
The phrase "granularity control for advanced reporting" is not accurate anymore. Although we offer much better exception handling now, we are currently not offering granularity control at a global level (previously implemented by the check() interface). If that were to be changed, we can restore that headline. I instead replaced with the phrase "Advanced exception handling", which accurately describes what we offer. I also removed the `concrete-api.md`, which was a document describing how we don't rely on static calls. We do, in fact, recommend some of them, such as `ValidatorBuilder::init`, and although they can be avoided, it relies on setting up a custom container which we do not offer full documentation for yet.
henriquemoody
approved these changes
Feb 1, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The phrase "granularity control for advanced reporting" is not accurate anymore. Although we offer much better exception handling now, we are currently not offering granularity control at a global level (previously implemented by the check() interface).
If that were to be changed, we can restore that headline. I instead replaced with the phrase "Advanced exception handling", which accurately describes what we offer.
I also removed the
concrete-api.md, which was a document describing how we don't rely on static calls. We do, in fact, recommend some of them, such asValidatorBuilder::init, and although they can be avoided, it relies on setting up a custom container which we do not offer full documentation for yet.