TME-2684 - Add docs and contributing guidelines

[closb]

I added doc comments and edited existing docs to adhere to best practices. I also added README in examples directory that provide a brief explanation of the setup and pertinent information.

The docs contain the recommended sections for open source documentation. Minus the structure, the edits to the context were minimal and mostly consisted of grammar for brevity and clarity.

I have added the wip prefix to files until we come to a consensus and agree on context and format.

That said, the current contributing file is missing information and is a boilerplate which is taken directly from the contributors covenant known as the de-facto standard for open source projects.

I have also added context and references to the Jira ticket to explain the path I chose and reasons why.

[bachu20]

Suggested documentation changes look amazing, thanks for the awesome work on this! 🔥 Only thing left before this is good to go is to handle the pre-commit & formatting failures. Otherwise the changes are good to merge in (after removing the wip file prefixes) as far as I'm concerned.

[closb]

@bachu20 sounds good, thanks brother, it was definitely a learning experience! I'll bring it up during standup that this is ready to go, the only remaining issue is the contributing doc. I posted on the ticket what needs to be, or should be changed.

[bachu20]

@closb I'll create a separate task to address the security concerns noted by the scan-tf task.

[closb]

@bachu20 sounds good, thanks!