Skip to content

Create high level documentation for Golang implentation #3198

@amoeba

Description

@amoeba

What feature or improvement would you like to see?

The docs for the Golang implementation currently just link directly to the godoc site: https://pkg.go.dev/github.com/apache/arrow-adbc/go/adbc. This documentation is useful but doesn't contain much prose and might not be that useful for new users, especially those evaluating the package.

Other implementations have higher level docs as part of the Sphinx docs with sections like,

  • Quickstart
  • Driver Manager
  • API Reference
  • Cookbooks

And I think having a higher level set of docs for Golang would be good. In Golang's case, the API Reference could still link to the godoc site but the other sections would new new content.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions