docs: update docs for 1.5 release.#137
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation for the 1.5 release by adding additional Java examples and refining benchmark and task list details.
- Added a new link for Java examples in the README.
- Updated benchmark performance description and task status regarding Java auto-mapping.
- Revised task list items to reflect current progress and pending documentation improvements.
Comments suppressed due to low confidence (5)
README.md:168
- Verify that the Java examples link is accessible and reflects the current release conventions.
Additional Java examples can be found in the [Kapper-Example](https://github.com/driessamyn/kapper-examples#java-examples)
README.md:456
- Consider clarifying the performance measurement by specifying whether this timing is an average or worst-case scenario and ensuring consistent language.
In the current version of Kapper the _"cost"_ of auto-mapping in the small single digit _microsecond_ range.
README.md:479
- Since Java auto-mapping is now marked as complete, please ensure that corresponding tests and usage examples are included in the repository.
+- [x] Support auto-mapping for Java records.
README.md:480
- Ensure that the newly added tests and examples for other JVM languages are comprehensive and integrated into continuous integration where applicable.
+- [x] Tests & examples in other JVM languages.
README.md:487
- [nitpick] Consider providing a roadmap or plan outlining which areas of the documentation and website will be enhanced to set clear expectations for contributors.
+- [ ] Improve user documentation / docs website.
PR Code Suggestions ✨Explore these optional code suggestions:
|
|||||||||
|
Unit Tests 41 files ±0 41 suites ±0 17s ⏱️ ±0s Results for commit 67fa9ac. ± Comparison against base commit 40147a3. This pull request removes 2 and adds 1 tests. Note that renamed tests count towards both. |
Code Coverage
|
CI Feedback 🧐A test triggered by this PR failed. Here is an AI-generated analysis of the failure:
|



No description provided.