Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from

Conversation

CommanderStorm
Copy link
Contributor

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
Copy link
Contributor Author

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..

@LucioFranco
Copy link
Member

@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.

@CommanderStorm
Copy link
Contributor Author

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

Shure. have opened #2308 for the docs change
Since I don't have rights in this repo (hypothesis), reopening is not a possibility.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants