search

defenseunicorns / pkg

Common Go modules maintained by Defense Unicorns
Apache License 2.0
5 stars 4 forks source link

Cleanup and link go package docs for Zarf library code #8

Closed Racer159 closed 3 months ago

Racer159 commented 7 months ago

Describe what should be investigated or refactored

We should go through our logic within src/pkg and make it easier to browse and understand in pkg.go.dev. This is a common way for library devs to read about a package and there are some issues with ours. Namely:

Overview repeats: image

Descriptions assume you know a lot about Zarf: image (Duh Archive as a receiver to component archives a component but what does it do?)

Links to any relevant code

https://pkg.go.dev/github.com/defenseunicorns/zarf@v0.32.2/src/pkg/layout

Additional context

This would help Zarf be used by library users and we should also link our pkg.go.dev pages in our own docs.