Set up godoc server #29

New Issue

bvisness · 2022-05-26T14:49:16Z

bvisness commented

2022-05-26 14:49:16 +00:00

I would like to use the Go documentation system for technical documentation of the website codebase. I've already documented the db package in some detail, and I'd like to do others too. However, we looked into using pkg.go.dev and I don't think it will really work, because it requires us to license our code in a particular way (a step we're not ready to take), and it requires updated versions of our code to be stored in the Go package index / proxy, which really only happens if people are running go get on our code (and they do not ever do this).

We should run a custom godoc server at godoc.handmade.network for this purpose. It can probably just run off our Git server, I guess?

I would like to use the Go documentation system for technical documentation of the website codebase. I've already documented the `db` package in some detail, and I'd like to do others too. However, we looked into using pkg.go.dev and I don't think it will really work, because it requires us to license our code in a particular way (a step we're not ready to take), and it requires updated versions of our code to be stored in the Go package index / proxy, which really only happens if people are running `go get` on our code (and they do not ever do this). We should run a custom godoc server at godoc.handmade.network for this purpose. It can probably just run off our Git server, I guess?

bvisness added the

admins only

label 2022-05-26 14:49:21 +00:00

This repo is archived. You cannot comment on issues.