docs: document 'top level' packages

[alexmt]

No description provided.

[codecov]

Codecov Report

Merging #44 into master will decrease coverage by 0.01%.
The diff coverage is 83.33%.

@@            Coverage Diff             @@
##           master      #44      +/-   ##
==========================================
- Coverage   52.60%   52.58%   -0.02%     
==========================================
  Files          25       25              
  Lines        2591     2590       -1     
==========================================
- Hits         1363     1362       -1     
  Misses       1101     1101              
  Partials      127      127              

Impacted Files	Coverage Δ
pkg/cache/cluster.go	54.00% <ø> (-0.42%)	⬇️
pkg/cache/resource.go	85.18% <ø> (ø)
pkg/diff/diff.go	59.82% <ø> (ø)
pkg/health/health.go	55.89% <ø> (ø)
pkg/sync/common/types.go	52.17% <ø> (ø)
pkg/sync/sync_context.go	63.35% <66.66%> (ø)
pkg/cache/settings.go	72.00% <100.00%> (+3.81%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 99bd42d...0069d06. Read the comment docs.

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities (and 0 Security Hotspots to review)
2 Code Smells

No Coverage information
2.7% Duplication

[jannfis]

Documentation looks usable to me! Good job :)