docs: more intro clarification #21
Merged
Conversation
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
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR improves the clarity of the introduction in the service API vs REST documentation by restructuring and refining the abstract section.
- Reorganized the abstract to better explain NATS benefits and Leopard's role
- Added clarification about Leopard's specific contribution (Easy Button for concurrency)
- Fixed grammatical issues in the description of REST request simplicity
| Leopard’s NATS ServiceApi wrapper delivers full-featured service-to-service communication, comparable with REST/GRPC. | ||
| With NATS, you get complete with discovery, health checks, per-endpoint scaling, and observability. | ||
| This abstraction preserves the simplicity of REST request with the resilience of asynchronous messaging | ||
| With NATS, you get discovery, health checks, and observability, all at the protocol layer. |
There was a problem hiding this comment.
[nitpick] The sentence structure could be improved. Consider rephrasing to: 'With NATS, you get discovery, health checks, and observability all at the protocol layer.' (removing the comma before 'all').
Suggested change
| With NATS, you get discovery, health checks, and observability, all at the protocol layer. | |
| With NATS, you get discovery, health checks, and observability all at the protocol layer. |
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.
No description provided.