Add docc docs for grpc core #2016
Merged
Conversation
This file contains 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
Motivation: As we move towards v2 we need to make a clearer separation between v1 and v2 docs to avoid confusion. Modifications: - Remove v1 specific content out of README.md (it is duplicated in the v1 DocC docs) and provide a clearer update on the state of the project. This also points users to the v1 docs on Swift Package Index where the duplicated v1 content lives. - Add a doc catalog to gRPC core with a very high level description of the package products - Add a "Benchmarks" tutorial to the v2 doc catalog (it was content removed from the README) Result: - DocC catalog in place for v2 - README is clearer
gjcairo
reviewed
Aug 14, 2024
| transports built on top of SwiftNIO's Network.framework abstraction, `NIOTransportServices`. | ||
| - `GRPCProtobuf` provides serialization and deserialization components for `SwiftProtobuf`. | ||
|
|
||
| ## Topics |
There was a problem hiding this comment.
Is this section supposed to be empty or do we want to remove it / add something to it?
There was a problem hiding this comment.
It's not empty, it has the "Getting involved" subsection. There will be more subsections (e.g. tutorials/articles) in the future too.
## Topics is also magic: if you don't add it then DocC will add it and list all articles etc.
underneath it (as well as API docs).
If you add it manually it'll add in everything that you didn't explicitly add, so at the moment it'll look like this:
gjcairo
approved these changes
Aug 14, 2024
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.
Motivation:
As we move towards v2 we need to make a clearer separation between v1 and v2 docs to avoid confusion.
Modifications:
Result: