Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs #16

Open
tcodes0 opened this issue May 30, 2024 · 0 comments
Open

Docs #16

tcodes0 opened this issue May 30, 2024 · 0 comments

Comments

@tcodes0
Copy link
Owner

tcodes0 commented May 30, 2024

  • 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant