-
Notifications
You must be signed in to change notification settings - Fork 3.6k
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
Generate Protobuf Docs #7786
Comments
Opening this again, as I have one additional question. The current docs are https://docs.cosmos.network/master/core/proto-docs.html. It's in my opinion not very easy to digest. What do you think of:
|
While the current docs are not the best, until someone complains I think it is fine if we close this. Also users will be able to visit pkg.go.dev (https://pkg.go.dev/github.com/cosmos/cosmos-sdk@v0.42.5/x/bank/types) if they would like more detailed info on the types |
Summary
Generate protobuf docs like: https://rawgit.com/pseudomuto/protoc-gen-doc/master/examples/doc/example.html
Problem Definition
It would be nice to have some cross-language protocol documentation. Godocs are nice for go developers, but... we have protobuf now.
Proposal
https://github.com/pseudomuto/protoc-gen-doc seems to be the most mature tool. It's not wonderful but better than nothing. There could be others I haven't found. See also:
Other notes
For Admin Use
The text was updated successfully, but these errors were encountered: