Wiki alternative idea

[Guillaumecoi]

I came across a discussion about moving the wiki to the repository. While that sounds like a good idea, there’s a lot of nuance to consider. The settings and customization options can be overwhelming for new users, and maintaining high-quality documentation within the repo wouldn’t be easy.

What do you all think about:

1. Creating a separate repository for documentation
2. Using Hugo to generate a wiki website (which can be hosted on GitHub for free!)

Advantages:

• A well-structured, visually appealing wiki with minimal setup effort
• Built-in support for multiple languages
• Documentation remains in Markdown, so no new skills are required, and we can easily reuse existing content from the current wiki

Disadvantages:

• The wiki won’t be included when cloning the repo with git clone (though we could explore a script to enable offline viewing if needed)

I personally really like this theme, https://imfing.github.io/hextra/. But there are tons to choose from here: https://themes.gohugo.io/tags/docs/

I’ve set up something similar before, so if there’s interest, you could add me to the repo, and I can take care of the setup. If it doesn’t work out or feels impractical, the repo can always be deleted. Let me know what you think!

[kRHYME7]

Already checked this? https://github.com/HyDE-Project/hyde-site

I don't know yet how to do things.

I really love to have a version control and also a language selector too.

[Guillaumecoi]

Already checked this? https://github.com/HyDE-Project/hyde-site

Ooh, How did I not know about this yet? Maybe place a link to this inside of the README so it is easier to find?

[kRHYME7]

yeah, but it's not ready yet. Please do a MR for adding this wiki to the readme please.

[Guillaumecoi]

Okay, Do I replace the wiki link by the site link? Or do I make a new link "Website"?

[kRHYME7]

replace the wiki link to this new site

[Guillaumecoi]

I took a look at the Repo.

Version control is build into GitHub. Are you thinking of something else on top of that? Edit: never mind I just read your issue on this.

I don't know Astro docs, but it looks similar to Hugo. The main difference is Astro uses JavaScript to build the website, which makes it a bit slower but more customizable for people already knowing JavaScript. Implementing a language selector is something I could do.

I'm also thinking of changing this page: https://hydeproject.pages.dev/guides/getting-started/ to make it a bit more welcoming/inviting.

I guess I just make a PR, and you'll see if you like the changes or not, rather than discuss it here.