Chore: Document packages with readmes

[zmackie]

go packages should have some form of documentation to detail what the purpose of given package is for.

For example github.com/buildpacks/pack/internal/dist:

dist package provides utility classes and constants that adhere to the distribution spec: https://github.com/buildpacks/spec/blob/master/distribution.md

[zmackie]

@ameyer-pivotal I think this is what your meant by the project card. Feel free to edit if not.

[jromero]

@Zanadar this issue was more in regards to documenting go code packages. I've updated the description with an example for better clarity. @ameyer-pivotal, feel free to provide additional clarification if needed.

[dfreilich]

For context - is it best Go practice to have a readme in each directory? What should those Readmes look like?

[dfreilich]

Or would this be more for go-docs, where at the top of a file in each package we do something like:

// Package foo manages bar.
// ...
package foo

[vipinachar]

Hi @dfreilich , I would like to work on this issue. As per the latest comment, Is it okay to add description for packages at the top of file in each package?

[natalieparellano]

The information here could be helpful in this effort: https://go.dev/doc/comment

[microwavables]

@vipinachar so sorry for the delay in responding - Are you still interested in working on this issue?