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.

Sign up for GitHub

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

Jump to bottom

Improve documentation #22

Open

wagoodman opened this issue Jun 3, 2020 · 0 comments

Assignees

Contributor

wagoodman commented Jun 3, 2020

This library is the foundation of multiple container-based tools, documentation is critical here. There should be at least:

API documentation (pkg.go.dev/), which implies that in-line documentation for packages, structs, interfaces, and functions need to be added.
Higher-level concepts: an overview of what the library achieves, high level design, and basic interactions in a markdown file in this repo would be ideal.

wagoodman added this to the v0.1.0 milestone

wagoodman self-assigned this

wagoodman removed this from the v0.1.0 milestone

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment