Updated examples, simplified documentation and adding pre-commit to CI

[swade1987]

Towards #615

Context
This pull request addresses an issue where the links in the docs directory were not functional from the Terraform Registry perspective. The Terraform Registry requires legitimate, fully qualified URLs to render documentation correctly, necessitating these links to be accurate and accessible upon merging to the main branch. To maintain high standards of documentation and code, this PR also introduces a series of examples, integrates pre-commit checks into our Continuous Integration (CI) process, and incorporates tfplugindocs into our pre-commit hooks.

Changes

1. Documentation Links: To ensure the documentation links work seamlessly from the Terraform Registry, we've implemented hard-coded URLs that point to the expected locations within the main branch. This approach guarantees the validity and accessibility of the links post-merge.
2. Examples Addition: A comprehensive range of examples has been added to illustrate our provider's usage and capabilities. These examples aim to provide users with practical guidance and improve their overall experience.
3. Pre-commit Checks in CI: We've integrated pre-commit checks into our CI pipeline to enhance code quality and ensure that contributions adhere to our coding standards before merging.
4. tfplugindocs in Pre-commit: Adding tfplugindocs to our pre-commit hooks automates the generation and maintenance of our Terraform documentation, ensuring it remains up-to-date and consistent.

Note for Reviewers
The links within the docs directory are designed to be functional post-merge, as they rely on being legitimate, fully-qualified URLs per the Terraform Registry's requirements. Additionally, the introduction of examples, pre-commit checks, and tfplugindocs represents our commitment to maintaining high quality and usability standards in our project.

[stefanprodan]

LGTM

Thanks @swade1987 🏅