connectrpc / connectrpc/connectrpc.com
Hello world with Buf examples, starting from Java
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 40
- Forks
- 27
- Avg merge
- 7d 1h
- Merged PRs (30d)
- 10
Description
At the moment, the documentation contains a non-trivial example for Kotlin, which is a little counterintuitive. I propose the documentation offer "hello world"-style examples that only focus on the specific of setting up Connect in a specific language, leaving more advanced features and use cases in a separate section of the doc.
Also, since Java is still a popular language, and Kotlin is Java compatible, probably it would be great to have a "Getting started with Java" that mentions that the code generated is in Kotlin, and you need a certain setup, but you can use Connect when coding in Java
Reference: https://connectrpc.com/docs/kotlin/getting-started/
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the referenced Kotlin getting-started documentation at https://connectrpc.com/docs/kotlin/getting-started/. Separate the basic Connect setup from advanced examples and add a Java getting-started path that explains the Kotlin-generated code and required setup; done means both languages have focused Hello World guidance.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, kotlin
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100