Skip to content

cloudrad: Cross-library links #62

Description

@dazuma

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.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    priority: p3Desirable enhancement or fix. May not be included in next release.type: feature request‘Nice-to-have’ improvement, new feature or different behavior or design.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions