googleapis / googleapis/ruby-common-tools

cloudrad: Cross-library links

Open
#62 0 comments 0 reactions 0 assignees View on GitHub
priority: p3 type: feature request
Dominant language
Ruby
Stars
5
Forks
13
Avg merge
1h 5m
Merged PRs (30d)
9

Description

Cross-reference links sometimes span libraries. Common cases include:

* References in wrapper libraries that reference types in gapic libraries.
* References to protobuf core classes like `::Google::Protobuf::Map` (usually common types such as `::Google::Protobuf::Timestamp` are already generated in proto_docs). We should include the google-protobuf gem in cloudrad and link to the appropriate definitions there
* Similar for other common gems such as gapic-common and google-cloud-core.
* References to Ruby core classes that could link to ruby-doc.org

We should have enough control over the overall generation and maintenance of these docs that we can provide cross-reference links for those cases.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.