Enhance documentation#231
Merged
Merged
Conversation
… example in package documentation
… and completeness
…h packages in module-info
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.
This pull request introduces the new Communication API to Jakarta NoSQL, providing a minimal and extensible foundation for interacting with various NoSQL database models (key-value, document, column, and graph) while preserving native database semantics. The changes include comprehensive documentation updates, new API module exports, and detailed package-level descriptions for each communication model.
Introduction of the Communication API:
Documentation and Usage Examples:
README.adocwith detailed explanations and code samples for the key-value, document, column, and graph communication models, illustrating how to interact with each NoSQL paradigm using the new API.API and Module Enhancements:
module-info.javato export new communication model packages (document,keyvalue,column,graph) and provided a detailed module-level description of the Communication API’s purpose and design principles.Package-Level Documentation:
communicationpackage and each subpackage, clearly describing the intent, design, and extensibility of the Communication API, with specific focus on the graph communication model. [1] [2]