feat: Add Support for mkdocs

[Dinesht04]

Affects /docs - (Refined Documentation for deployment and added Some Supporting documentation)
Added a github action for deployment

Fixes #835

Added Support for mkdocs
Example - https://dinesht04.github.io/go-sdk/

Requires Configuration of Github pages as follows:-

1. Enable Github Pages
2. Select gh-pages branch for deployment

Sources

For mkdocs.yaml

1. https://github.com/modelcontextprotocol/python-sdk/blob/main/mkdocs.yml
2. https://github.com/modelcontextprotocol/java-sdk/blob/main/mkdocs.yml
3. MKDocs official documentation

For Github Action

1. https://github.com/modelcontextprotocol/python-sdk/blob/main/.github/workflows/publish-docs-manually.yml
2. https://github.com/modelcontextprotocol/java-sdk/blob/main/.github/workflows/docs.yml
3. https://github.com/james-willett/material-mkdocs-youtube-2024/blob/main/.github/workflows/ci.yml - From Youtube Tutorial

[jba]

nit: we don't use the feat|chore|... prefix in our commit messages.

[Dinesht04]

Hey, I'm actually a little confused, I think I messed up something while force pushing my changes and the latest changes aren't reflecting 😅 . Looking into it right now

[Dinesht04]

hey @maciej-kisiel , followed up on your suggestions and updated the code ^_^

[maciej-kisiel]

After you apply the changes, could you re-deploy the docs to the link in your description?

[maciej-kisiel]

nit: we don't use the feat|chore|... prefix in our commit messages.

@jba I am guilty of that as well.. Sometimes I put "chore:" when there is no clear Go package that is changed, e.g. when I'm just modifying GitHub Actions configuration. Do you have a suggestion for a better prefix in such cases?

[jba]

We use the package ("oathex: frob widgets") or the file ("go.mod: update to 1.26") or sometimes nothing, if it's hard to describe the scope.

[Dinesht04]

hey @maciej-kisiel here are the deployed docs with the latest changes
https://dinesht04.github.io/go-sdk/

Also, I included a contributing.src.md in internal/docs to pass the doc-check test which includes the pymarkdown snippet.
the doc-check matches the /docs directory from what files would have been generated in internal/docs when go generate would have been executed.