Add DocC catalog and README #3
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: We should have a README to explain what the package is and should point to docs we publish to the Swift Package Index. Modifications: - Add a README - Add a .spi.yml - Add a DocC catalog Result: More docs
gjcairo
reviewed
Sep 27, 2024
Comment on lines
+19
to
+20
| - ``ProtobufSerializer`` | ||
| - ``ProtobufDeserializer`` |
There was a problem hiding this comment.
Do we want some more detail here?
There was a problem hiding this comment.
No, we're just listing links to types (these are the only ones) – DocC renders a summary of each inline:
| `grpc-swift` documentation on the [Swift Package | ||
| Index](https://swiftpackageindex.com/grpc/grpc-swift/documentation). | ||
|
|
||
| ## Topics |
There was a problem hiding this comment.
Do we want this empty section?
There was a problem hiding this comment.
Yes: if you don't have a ## Topic, DocC will insert it for you at the end of the doc.
Co-authored-by: Gus Cairo <[email protected]>
gjcairo
approved these changes
Sep 30, 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:
We should have a README to explain what the package is and should point to docs we publish to the Swift Package Index.
Modifications:
Result:
More docs