Add docs command

[csweichel]

Description

This PR adds a docs command which helps produce readme files for each combination. To this end, a Go template can be provided which is executed for each combination. Have a look at the defaultTemplate in the docs.go for an example.

Related Issue(s)

Fixes #

How to test

go run main.go docs --context example/ --all

Release Notes

NONE

[codecov[bot]]

Codecov Report

Merging #56 (eefb691) into main (d889756) will increase coverage by 0.62%. The diff coverage is 88.88%.

:exclamation: Current head eefb691 differs from pull request most recent head 987e8c8. Consider uploading reports for the commit 987e8c8 to get more accurate results

@@            Coverage Diff             @@
##             main      #56      +/-   ##
==========================================
+ Coverage   51.54%   52.16%   +0.62%     
==========================================
  Files           4        4              
  Lines         906      922      +16     
==========================================
+ Hits          467      481      +14     
- Misses        331      332       +1     
- Partials      108      109       +1     

Impacted Files	Coverage Δ
pkg/dazzle/project.go	59.91% <88.88%> (+1.99%)	:arrow_up:

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

[kylos101]

Hey @csweichel , I added this to the Workspace Project, set the status in In-Progress, and assigned you (so that we don't lose sight of this issue).

cc: @Siddhant-K-code @utam0k

[kylos101]

Hey @csweichel @Siddhant-K-code and @axonasif, is this still needed?

[Siddhant-K-code]

Hey @csweichel @Siddhant-K-code and @axonasif, is this still needed?

Yes, this PR was intended to create a markdown file containing the content of our workspace images. Which would help the better documentation for workspace images 🙏🏼

[kylos101]

:wave: hey there, removing this from the Team Workspace project (for now). @csweichel not sure if you want to pick this back up, but, it's not currently a priority.