feat: add ability to store package documentation

[AustinAbro321]

Description

Adds the ability to store documentation under the documentation key which is a map[string]string. Stores documentation files in the package by their base filename.

I decided not to include documentation from imported packages. If a user wants documentation from a package they are importing, it should be simple enough to copy that file and import the file separately, and I believe there are situations where documentation for an imported package, wouldn't make sense in the parent package.

Currently this feature does not allow pulling in remote files, I'd be open to adding this in the future if someone presents a use case.

One neat thing I learned is that if a user tries to define the same key twice in a yaml map then we will error, so no additional validation was needed for that.

Related Issue

Fixes #4346

Checklist before merging

• Test, docs, adr added or updated as needed
• Contributor Guide Steps followed

[netlify]

✅ Deploy Preview for zarf-docs canceled.

Name	Link
🔨 Latest commit	53265b2
🔍 Latest deploy log	https://app.netlify.com/projects/zarf-docs/deploys/692f2ee3308e240008d5a3d1

[codecov]

Codecov Report

❌ Patch coverage is 73.60000% with 33 lines in your changes missing coverage. Please review.

Files with missing lines	Patch %	Lines
src/cmd/package.go	77.77%	9 Missing and 3 partials ⚠️
src/pkg/packager/layout/assemble.go	42.10%	8 Missing and 3 partials ⚠️
src/pkg/packager/layout/package.go	74.28%	6 Missing and 3 partials ⚠️
src/pkg/zoci/pull.go	94.11%	1 Missing ⚠️

Files with missing lines	Coverage Δ
src/api/v1alpha1/package.go	32.55% <ø> (ø)
src/pkg/zoci/common.go	56.00% <ø> (ø)
src/pkg/zoci/pull.go	61.04% <94.11%> (+3.99%)	⬆️
src/pkg/packager/layout/package.go	58.67% <74.28%> (+1.46%)	⬆️
src/pkg/packager/layout/assemble.go	42.61% <42.10%> (+0.21%)	⬆️
src/cmd/package.go	39.51% <77.77%> (+1.34%)	⬆️

... and 10 files with indirect coverage changes

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[brandtkeller]

Couple passing thoughts but otherwise clean and straight-forward.

[brandtkeller]

Does this addition warrant bumping the package version (and possibly publishing)?

[AustinAbro321]

If we had a smoother workflow I think potentially, but currently it requires running a workflow to update the new version then updating our e2e tests that pull this package to use the new version, which can be cumbersome.

[brandtkeller]

Reasonable stance to take - though I can imagine we will see few examples in the future.

This stance is based on the storage mechanism in the package based on the assemble logic... Is it worth considering a broader copy strategy that prepends the key in order to establish more uniqueness?

[AustinAbro321]

My consideration was more so for the user when they get their documents. Keeping them unique makes it so their files are the same name when they read them. Though it is still probably best to prepend the filename with the key.