search

spring-projects-experimental / spring-grpc

88 stars 19 forks source link

Consolidate quick start docs #35

Closed onobc closed 1 month ago

onobc commented 1 month ago

Currently the README.adoc has more info around quick-start than the ref docs. Let's put this info in a single place in the ref docs and point to the ref docs from the README.

dsyer commented 1 month ago

I like having it in both. The README is easier to find for most people, especially if they aren't super familiar with Spring. In Spring Cloud the README is .adoc and autogenerated. I don't know if it's worth it, and it makes it harder to get people to contribute changes to the README. The alternative is just to live with the duplication. It won't kill us.

onobc commented 1 month ago

The content in both places would be nice and its easy to do. Not a high priority though but at the very least they need to be in sync and the README is ahead of the ref doc at this point.

dsyer commented 1 month ago

I pushed my readme branch onto main. So now they are in sync but not automatically up to date. The docs README has instructions on how to synchronize changes.