Labels Milestones

New Issue

Set up godoc server #29

Open

opened 10 months ago by bvisness · 0 comments

bvisness commented 10 months ago

Owner

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 10 months ago

Sign in to join this conversation.

No Branch/Tag Specified

Branches Tags

beta

conferences-page

db-rework

discord-tagging-for-real

education-prettier

feature/2023_frontend_updates

feature/handmade_cities_banner

foundation

jam-2022

live

master

moretwitch

pgx5

snippet_edit

stupid-broken-snippets

Labels

Apply labels

Clear labels

admins only
Exclusively for the HMN admin team bug
Something is not working design
Aesthetics required duplicate
This issue or pull request already exists gimme feedback
We would like more community input on this good first issue hmmmm
The HMN team needs to think on this one invalid
Something is wrong reference
Hub for planning and discussion wontfix
This won't be fixed

No Label admins only bug design duplicate gimme feedback good first issue hmmmm invalid reference wontfix

Milestone

Set milestone

Clear milestone

No items

No Milestone

Assignees

Assign users

Clear assignees

No Assignees

1 Participants

Notifications

Subscribe

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: hmn/hmn#29

Write Preview

Loading…

Cancel

Save

There is no content yet.