fix godoc building and update #277
Conversation
The ones _we_ build are crappier and are painful to get building properly. We
might as well link to other documentation sources.
* These new sources will _always_ be up to date.
* The new go documentation will:
* Properly hyperlink
* Not require one sidebar link per package. We currently have links in the
sidebar for subpackages that really don't belong as top-level links.
Stebalien
force-pushed
the
fix/godoc
branch
from
7f5ab26 to
277e641
Compare
|
Closes #276 |
|
FWIW, one of the main reasons we didn’t do this initially was to support a path towards #66, which godoc.org does not have great support for. NOT trying to disagree with this change (it’s probably the right move!); just want to provide some planning context if versioned API reference docs are still a major goal (I can’t see the spreadsheet linked from #66, but the comment makes it sound like it still is). |
|
@Mr0grog Thanks for finding that broken spreadsheet link! Spreadsheet creep -> separated the features list into this: https://docs.google.com/spreadsheets/d/1YJ8yuzoNeunVr3ftvm7x2nIKsj7IlTrsfuy71ZnGg6Y/edit#gid=785339355 Versioning is definitely a strong point on that roadmap -- specifically in API dictionaries but just in the docs as a whole. Also, hi! I've really appreciated the opportunity to lurk hard on all your previous work. 😄 |
|
Hm. You're right. Go module support in go doc (golang/gddo#567) should fix this but it's unclear how long that will take to land. |
|
Sweet, I had been wondering if godoc versioning would wind up coming along for the ride!
Awesome, happy if it’s helpful. 👋 |
I went ahead and nuked the Go API docs: