Add mkdocs-material docs gen and include CI docs (review)

[haani-niyaz]

Hi @shukra-in-spirit @vancanhuit , I've raised this PR for review on:

1. Documentation structure
2. Quickstart content
3. CI pages structure
4. CI content for gitleaks, pre-commit, mkdocs-material and golangci-lint

The documentation on publish will look similar to:
https://haani-niyaz.github.io/golang-template-repository/

Closes #21 and #28.

Required actions:

• Proof read content
• Enable gh-pages in template repo settings as mentioned in Proposal for docs in repo #21
• Add Sonarqube CI docs
• Reconcile with Begin autogenerating docs with mkdocs #23

@AlvinKuruvilla, there was an urgency to finish this piece of work so I've stepped in. Happy to discuss with you if required.

[jeffy-mathew]

since this is related to docs.
shall we use https://opencollective.com/vale to do a copy check?
https://github.com/errata-ai/vale-action - seems helpful in GitHub actions context

[haani-niyaz]

since this is related to docs. shall we use https://opencollective.com/vale to do a copy check? https://github.com/errata-ai/vale-action - seems helpful in GitHub actions context

This definitely looks interesting. We should have a story to explore it :)

For the purpose of this MR though, a more technical documentation review is required to validate if the information is helpful for repo owners to get started.

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[haani-niyaz]

@shukra-in-spirit thanks for merging this. Just checking if gh-pages was setup in the repo as per:
#21 (comment)

The site is URL is retuning a 404 atm.

[shukra-in-spirit]

Hey, I updated it.

[sonarqubecloud]

SonarCloud Quality Gate failed.   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
40 Code Smells

0.0% Coverage
10.2% Duplication