Skip to content

Conversation

glbrntt
Copy link
Collaborator

@glbrntt glbrntt commented Sep 24, 2024

No description provided.

@glbrntt glbrntt added the semver/none No version bump required. label Sep 24, 2024
@glbrntt glbrntt requested a review from gjcairo September 24, 2024 11:56
- 🪪 **License** is Apache 2.0, repeated in [LICENSE](License)
- 🔒 **Security** issues should be reported via the process in [SECURITY.md](SECURITY.md)

## Quick Start
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we maybe link to the hello world tutorial from the Quick Start section, maybe below the Package.swift? I'm thinking, someone may come in wanting to play with this, copy the manifest, and then might struggle a bit clicking around documentations on SPI. Having the link to the tutorial directly may make things slightly easier.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh that's a good point. I'd like the README to remain really focused by just having the bullet points (the manifest is the exception because it's easy to copy and paste). What if we add a "Tutorials" bullet to the list above between Documentation and Examples?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I ended up just mentioning tutorials in the documentation point above as they link to the same place.

@glbrntt glbrntt requested a review from gjcairo September 24, 2024 18:44
@glbrntt glbrntt merged commit cfa6743 into grpc:main Sep 30, 2024
5 of 8 checks passed
@glbrntt glbrntt deleted the v2/fix-docs branch September 30, 2024 07:38
@rnro rnro mentioned this pull request Sep 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
semver/none No version bump required.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants