Add Docusaurus-based documentation site

[Oridak771]

Description

I have developed a new documentation website for the kube-hetzner project using Docusaurus. This site is designed to be a comprehensive, easy-to-navigate resource for all users, from beginners to advanced. It is fully functional and ready for review.

Why It Helps:

• While the current README.md is a good starting point, a dedicated documentation site offers several key advantages:

• Improved Navigation: A sidebar with a clear structure allows users to easily find the information they need without scrolling through a single large file.

• Search Functionality: Docusaurus comes with built-in search, which is a significant improvement for a project with many configuration options.

• Documentation Versioning: As kube-hetzner releases new versions with breaking changes or new features, Docusaurus can snapshot the documentation for each version. This allows users to access documentation that corresponds to the specific version of the module they are using, preventing confusion.

• Better Readability: Complex topics can be broken down into smaller, more digestible pages with better formatting, code blocks, and visual aids.

• Live Demo: https://oridak771.github.io/DocKube-hetzner/

• Source Repo: https://github.com/oridak771/DocKube-hetzner

Would you be open to me submitting a pull request to link to this live demo in the main README.md for now?

Longer-term, what would be your preference for where this documentation should live? I'm happy to help with either option:

Transfer the repository to the Kube-hetzner organization.

Move the Docusaurus project into a /docs folder within the main terraform-hcloud-kube-hetzner repository.

Looking forward to your feedback!

[pat-s]

Would you be open to me submitting a pull request to link to this live demo in the main README.md for now?

Just my two cents: while its cool you did this and it is surely an improvement over a plain README, linking an externally managed doc site is quite an anti-pattern.

One never knows if its up-to-date and it won't stay updated when its being managed by an external person outside of the normal PR flow.

Personally, I am not a fan of docusaurus docs but this is just personal pref. Asking beforehand if that would be in scope and docusaurus is wanted (maybe it is) might have saved you precious time. But, I am not making any decisions here :)

[mysticaltech]

@pat-s Indeed docusorus may not be ideal. FYI @Oridak771 is a personal friend.

@Oridak771 Thanks for this, appreciate it very much. Please delete the demo site, and if you want use the /docs folder to create documentation from code, the README.md, and most importantly the kube.tf.example file. Ideally it should be upgradable fast based on changes to these files (think AGENTS.md rules), and created by a coding agent like gemini cli, using gemini 2.5 pro or stronger, that way it can really leverage the long context.

I would recommend using mkdocs.org for this, then shooting a PR. If all is good, I will then publish the docs using github pages.