blackfriday icon indicating copy to clipboard operation
blackfriday copied to clipboard

Confusing godoc situation

Open jmafc opened this issue 5 years ago • 0 comments

If you search for "markdown" on godoc.org, the first item that comes up is "github.com/russross/blackfriday" with 2160 imports and 3780 stars ATM. If you click on it, you're taken to https://godoc.org/github.com/russross/blackfriday. If, eventually, after starting to use that version and encountering problems, you visit the GitHub repo, you may discover (if you happen to read the second and third sections of the README) that the recommended version is not the version you've been dealing with, but the v2 version which you now have to get from somewhere else. And if you look back back at the godoc.org "markdown" results, you do find the v2 version but it's in sixth place, well below the "fold". And the godoc page for the original version has no mention of the new, preferred version. I would recommend that at the very least, a noticeable "STOP! You may want to look at V2" be put at the top of the godoc page, i.e., in your doc.go file, to avoid other frustrated visitors/developers.

jmafc avatar Jun 21 '19 01:06 jmafc