Use a documentation framework for documentation instead of the wiki

[The-LukeZ]

I find it hard to work with Github Wiki - I personally love to document with either Astro Starlight, Vitepress or any other SSG.

The easiest way is using Github pages - which could also use a custom domain if you guys configure it.

I would love to make a PR with those changes added. You guys would need to go in the Repository settings and configure Github pages.

Why I think this benefits the whole documentation process

SSGs let you version your docs alongside your code in the same repo, so documentation stays in sync with changes and goes through the same review process as code. GitHub Wikis are disconnected from your codebase, don't support custom CI/CD pipelines, and offer far less control over structure, styling, and deployment.

They are also a hard to edit because we can't create PRs on it to document.

---

Sidenote: Vitepress uses plain markdown with optional Vue components. Astro Starlight uses mdx by default, which is markdown but with compatability with React/Svelte/Vue/... components - Astro also has their own components which are very nice to work with.

---

Let me know what you think!

[bastigamedc]

We know we need to improve this. Unfortunately, we don't have time for it right now. As soon as we have time, we'll get started on this project as well.

[The-LukeZ]

I (personally) would do the following:

• put it in this repo
• use pnpm as package manager (allows for better workspace management)

I've done this and it works well (see my honocord repo) - let me know what you think 😄

Edit: I can also recommend Fuma docs, if you want to keep using React as the framework (Astro Starlight would also support React)