Generate Protobuf Docs

[aaronc]

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:

• Compile protobuf messages to multiple languages for easier client development #7717 (comment)
• https://github.com/grpc-ecosystem/awesome-grpc
• https://blog.productsup.dev/2020/05/grpc-and-protobuffer-api-documentation-with-proto2asciidoc-and-code2asciidoc/

Other notes

• Update TODO links in docs:
  • docs: Add grpc & rest endpoints overview #8064 (comment)
  • docs: Add grpc & rest endpoints overview #8064 (comment)

---

For Admin Use

• Not duplicate issue
• Appropriate labels applied
• Appropriate contributors tagged
• Contributor assigned/self-assigned

[amaury1093]

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:

• removing this page from "Core Concepts",
• add one individual page per module, containing that module's proto docs
  ?

[tac0turtle]

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/[email protected]/x/bank/types) if they would like more detailed info on the types