Docs #16
Description
- remove readme link to wiki, host docs at pkg.go.dev
- add doc.go file with package level comment
- improve style of comments by reading docs on how to write docs
- document every public field in every public struct, document all public structs, types and functions
- declare and document similar vars and consts together, that code shows in documentation as a block
- for commands, describe the command on the doc.go file, but instruct reader to pass -h to see usage and flags
- write interactive cmd docs in usage function and flag.Help
internal wiki for docs might be useful in private repos, need a simple utility to convert go doc to markdown. See https://pkg.go.dev/go/doc/comment for primitives on how to do this. See https://pkg.go.dev/golang.org/x/pkgsite/cmd/pkgsite run it locally for private repositories.