docs: Add documentation based on the youtube video

[joshka]

There's a lot of technical detail that went into creating this CI configuration, and you noted that it wasn't documented particularly well in the youtube vid covering it. I've added my understanding of what you wrote, as well as some basic instructions on how to incorporate this into an existing repo. I took the approach of what would I need to understand if looking at each action / workflow just by reading the code (rather than having to jump off into PRs and twitter messages to understand). I added a readme to the .github folder, which I think would be useful to help guide users into a pit of success using this repo.

Thanks for creating this. It's pretty useful.

[kovyrin]

Noticed an issues with this PR. The README.md file in .github directory ends up overriding the main readme file used by Github web UI (the UI picks up this file instead of the one in the root of the project). I think it'd make sense to rename it into something else.

[joshka]

@kovyrin fixed the issue with the naming.

[jonhoo]

This is great, thanks for taking the time! Left a few notes inline.

[c-git]

TLDR

I want to make a PR that starts from this one and adds what I learn during testing and want to know if @joshka would be ok with that?

Long Version

@joshka Do you have the time to make the requested changes? I'm trying to integrate this repo into my workflow and want to have the headings you were adding. I was in the process of testing how these work and wanted a place to document what I find. Going to defer testing for now until this PR lands. I realistically don't know when I will be able to get back to this (just didn't want to duplicate work now nor step on anyone's toes) but if you haven't had time to do it yet before I get back to it would you mind me creating a "follow up" PR that starts from you PR and add what I learn?

[joshka]

@c-git apologies for not getting to this sooner. Just going through a bunch of PRs to clean up things now - I've addressed All @jonhoo's comments with the latest push.

[c-git]

No worries, I know how life goes.

[jonhoo]

Looking great, thanks!