Steve/better docs #110
Steve/better docs #110
Conversation
docs/404.html
Outdated
| @@ -0,0 +1,24 @@ | |||
| --- | |||
There was a problem hiding this comment.
It believe it's generated by default with jekyll new. Seems ok to me.
docs/index.md
Outdated
| **Json:** | ||
|
|
||
| ```scala | ||
| val client = new HaberdasherClientJson(httpService) |
There was a problem hiding this comment.
didn't we want to remove the jsonclient? let's do that and not document it?
There was a problem hiding this comment.
It's part of the Twirp protocol, and also an officially supported proto3 serialization format, so we do want to support it as a general matter in this library.
There was a problem hiding this comment.
I think we had a discussion about this already and decided to remove it. Happy to discuss this again if needed.
There was a problem hiding this comment.
The latest twinagle release fixes the issue with the Json client, so we don't need to remove it. Let's mention the binary protobuf client first, and documenting that it should be used unless a human being needs to look at the data on the wire?
docs/index.md
Outdated
| ```scala | ||
| import twitch.twirp.example.haberdasher.HaberdasherService | ||
|
|
||
| class ServiceImpl extends HaberdasherService { |
There was a problem hiding this comment.
Let's call this HaberdasherServiceImpl then?
stevesoundcloud
force-pushed
the
steve/better-docs
branch
from
84263dd to
3c74031
Compare
stevesoundcloud
force-pushed
the
steve/better-docs
branch
from
3c74031 to
933c547
Compare
No description provided.