tonic icon indicating copy to clipboard operation
tonic copied to clipboard

docs(tonic-build): try to improve the doc-diff between `tonic-build`'s `lib.rs` and Readme

Open CommanderStorm opened this issue 1 year ago • 1 comments

Motivation

I had a bit of a hard time figuring out the getting started guide. This PR tries to improve a bit on these shortcomings:

image

Solution

  • merge the lib.rs and Readme to avoid getting to the same place in a few months
  • try to reword a few of the sentences, such as explain where the example code belongs (might sound obvious to you, it is not when having not worked with build scripts that generate code..)

CommanderStorm avatar Nov 05 '24 01:11 CommanderStorm

Not quite happy with the ginormous google example being in the docs at this place. Problem: I don't know of a better solution off the top of my head..

CommanderStorm avatar Nov 05 '24 01:11 CommanderStorm

@CommanderStorm are you still interested in pushing this change through? If so feel free to reopen the PR and we can get some of this reviewed and merged.

LucioFranco avatar Jun 20 '25 15:06 LucioFranco

If so feel free to reopen the PR and we can get some of this reviewed and merged

Shure. have opened https://github.com/hyperium/tonic/pull/2308 for the docs change Since I don't have rights in this repo (hypothesis), reopening is not a possibility.

CommanderStorm avatar Jun 20 '25 22:06 CommanderStorm