Add package docs so Karpenter displays better on `https://pkg.go.dev/github.com/aws/karpenter`

[tzneal]

Tell us about your request Improve package documentation so it's parsed and displayed at https://pkg.go.dev/github.com/aws/karpenter

Tell us about the problem you're trying to solve. What are you trying to do, and why is it hard? A better user experience for people using https://pkg.go.dev/github.com/aws/karpenter to explore the Karpenter source code.

Are you currently working around this issue? N/A

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

[billrayburn]

Do it for https://pkg.go.dev/github.com/aws/karpenter-core and maybe also https://pkg.go.dev/github.com/aws/karpenter .

[jonathan-innis]

Linking the karpener-core issue: https://github.com/aws/karpenter-core/issues/333