search

eBay / akutan

A distributed knowledge graph store
Apache License 2.0
1.65k stars 107 forks source link

Add GoDoc badge, etc #20

Closed ongardie-ebay closed 5 years ago

ongardie-ebay commented 5 years ago

Please hold off on this review for a minute so I can add a package-level doc for api/beam-api.

ongardie-ebay commented 5 years ago

There are a couple of remaining issues:

  1. facts, msg, tools, and util are directories that don't contain any go files, and godoc.org doesn't appear to discover them on its own. Should I add doc.go files to those directories?

  2. Our import paths on godoc.org are all broken, so links between package types don't work. I don't know what we can do about that without moving away from GOPATH.

....and @superfell merged this while I was typing this out 🤷‍♂️