Skip to content
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

Closed
2 of 6 tasks
aaronc opened this issue Nov 3, 2020 · 2 comments · Fixed by #8238
Closed
2 of 6 tasks

Generate Protobuf Docs #7786

aaronc opened this issue Nov 3, 2020 · 2 comments · Fixed by #8238
Assignees
Labels
S:proposed T:Docs Changes and features related to documentation.

Comments

@aaronc
Copy link
Member

aaronc commented Nov 3, 2020

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

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@aaronc aaronc added backlog T:Docs Changes and features related to documentation. labels Nov 3, 2020
@aaronc aaronc added this to the v0.40.1 milestone Nov 3, 2020
@aleem1314 aleem1314 self-assigned this Dec 29, 2020
@mergify mergify bot closed this as completed in #8238 Dec 31, 2020
@aaronc aaronc removed the backlog label Dec 31, 2020
@amaury1093
Copy link
Contributor

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
Copy link
Member

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S:proposed T:Docs Changes and features related to documentation.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants