search

landlock-lsm / go-landlock

A Go library for the Linux Landlock sandboxing feature
MIT License
105 stars 7 forks source link

Auto-generated documentation #24

Closed l0kod closed 1 year ago

l0kod commented 1 year ago

As for https://github.com/landlock-lsm/rust-landlock/pull/13, I think it would be nice to update the API documentation as soon as it get merged.

I guess we could use https://code.rocketnine.space/tslocum/godoc-static

gnoack commented 1 year ago

For Go, the Go team maintains a service which renders and caches the documentation for all open source packages at https://pkg.go.dev/github.com/landlock-lsm/go-landlock/landlock. It gets automatically updated and is used pretty consistently in the Go community. This is what I'm also linking to in the readme file.

So unless you want to host the documentation on a separate domain somewhere, I think we should be fine as is? (Please reopen if you think this is not sufficient)