trueblocks-core icon indicating copy to clipboard operation
trueblocks-core copied to clipboard

Enable automatic production of GoLang package documentation

Open tjayrush opened this issue 3 years ago • 2 comments

tjayrush avatar Aug 06 '22 22:08 tjayrush

@dszlachta This one is pretty simple, I think. The basic idea is that our pkg folder can be pushed to the GoLang documentation site every time we merge into master. I've been trying to use the documentation feature locally and it's really helpful. This is a "self contained" project, so you can write a PR from develop.

tjayrush avatar Aug 08 '22 20:08 tjayrush

pkg.go.dev automatically fetches tags, right now it's up-to-date with 0.37. I'm not sure if it's possible to push code without tag (or if we want users to use such code as package). I've added plain text license in a PR, this should make documentation for the subfolders in our code visible as well.

dszlachta avatar Aug 12 '22 13:08 dszlachta