Documentation updates and reformatting

[Gogotchuri]

This PR updates documentation to match the current version of the repository.
And reformats all of the documents to a newer markdown standard.

Resolves #51
Resolves #99

Checklist

• I have read the contribution guide.
• I have not used an AI coding assistant to create this PR.
• I have written all code in this PR myself OR I have marked all code I have not written myself (including modified code, e.g. copied from other places and then modified) with a comment indicating where it came from.
• I (and other contributors to this PR) have not looked at the Terraform source code while implementing this PR.
• If I'm releasing, I have read the releasing guide.

Go checklist

• I have run golangci-lint on my change and receive no errors relevant to my code.
• I have run existing tests to ensure my code doesn't break anything.
• I have added tests for all relevant use cases of my code, and those tests are passing.
• I have only exported functions, variables and structs that should be used from other packages.
• I have added meaningful comments to all exported functions, variables, and structs.

[tzabbi]

Do you want to add a github job to lint over the markdown files?

[Gogotchuri]

@tzabbi Good idea.
I would prefer it to be less invasive. We can create a workflow to check if markdown files are linted correctly and return an error otherwise. Let's leave it to the contributor to sort the linting part themselves. I would also prefer the check to be non-mandatory.

[diofeher]

@Gogotchuri Agreed. Just checking would be enough.

[diofeher]

Thanks for doing this work, Ilia! Good call on removing the Sublime Text stuff.