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

Added cosmos gRPC docs #32

Merged
merged 1 commit into from
Oct 27, 2020
Merged

Added cosmos gRPC docs #32

merged 1 commit into from
Oct 27, 2020

Conversation

crypto-eddy
Copy link
Contributor

  • Note that the cosmos-grpc-docs.md file is a tool generated file

@lezzokafka
Copy link
Collaborator

lezzokafka commented Oct 27, 2020

Thanks @eddycpc! One quick suggestion before i go ahead:

  • I think some of these items can be categorized by different modules on the sidebar?
  • Should #google.protobuf.* pointing to somewhere?

Copy link
Contributor

@leejw51crypto leejw51crypto left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

docs/resources/cosmos-grpc-docs.md Show resolved Hide resolved
docs/resources/cosmos-grpc-docs.md Show resolved Hide resolved
docs/resources/cosmos-grpc-docs.md Show resolved Hide resolved
docs/resources/cosmos-grpc-docs.md Show resolved Hide resolved
docs/resources/cosmos-grpc-docs.md Show resolved Hide resolved
docs/resources/cosmos-grpc-docs.md Show resolved Hide resolved
docs/resources/cosmos-grpc-docs.md Show resolved Hide resolved
docs/resources/cosmos-grpc-docs.md Show resolved Hide resolved
docs/resources/cosmos-grpc-docs.md Show resolved Hide resolved
docs/resources/cosmos-grpc-docs.md Show resolved Hide resolved
@crypto-eddy
Copy link
Contributor Author

crypto-eddy commented Oct 27, 2020

@lezzokafka

The docs in the cosmos-grpc-docs.md file are auto-generated by https://github.com/pseudomuto/protoc-gen-doc.
I don't know if it's worth manually modify the auto-generated file since as the .proto files get updated often, we might always come back to generate again.

I think some of these items can be categorized by different modules on the sidebar?

In this case, we might have to generate these files one by one

Should #google.protobuf.* pointing to somewhere?

This might probably require us to include all third-party definitions, this file might extremely large I think.

@calvinaco
Copy link
Collaborator

@lezzokafka

The docs in the cosmos-grpc-docs.md file are auto-generated by https://github.com/pseudomuto/protoc-gen-doc.
I don't know if it's worth manually modify the auto-generated file since as the .proto files get updated often, we might always come back to generate again.

I think some of these items can be categorized by different modules on the sidebar?

In this case, we might have to generate these files one by one

Should #google.protobuf.* pointing to somewhere?

This might probably require us to include all third-party definitions, this file might extremely large I think.

I agree with @eddycpc , I think we can leave the doc this way.

Copy link
Collaborator

@calvinaco calvinaco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On the other hand, I think it is better to crate a simple scripts for generating the docs. That way everyone can generate it in the future.

@calvinaco
Copy link
Collaborator

/staging

@lezzokafka
Copy link
Collaborator

I see. Sure if it's just for reference 👯

@crypto-eddy
Copy link
Contributor Author

On the other hand, I think it is better to crate a simple scripts for generating the docs. That way everyone can generate it in the future.

This is a good suggestion, I thought about this too but I realized it would be cool if that automation script can be done in a separate PR to keep this one small and focused on a single task.

That task to add an automated script to download the latest gRPC definitions and generate a new doc file can be a separate task on its own I believe

@lezzokafka
Copy link
Collaborator

lezzokafka commented Oct 27, 2020

That task to add an automated script to download the latest gRPC definitions and generate a new doc file can be a separate task on its own I believe

Sure, feel free to start a separated issue for that.

@crypto-eddy
Copy link
Contributor Author

On the other hand, I think it is better to crate a simple scripts for generating the docs. That way everyone can generate it in the future.

This is a good suggestion, I thought about this too but I realized it would be cool if that automation script can be done in a separate PR to keep this one small and focused on a single task.

That task to add an automated script to download the latest gRPC definitions and generate a new doc file can be a separate task on its own I believe

Related to #33

@crypto-eddy crypto-eddy merged commit 3549249 into master Oct 27, 2020
@tomtau tomtau deleted the Add-cosmos-grpc-docs branch October 29, 2020 01:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants