Proposal: Refresh Goravel Documentation UI

[livghit]

Before feedback (在反馈之前)

• There are no features that I want to submit in Issues (当前 Issues 中没有我将要提交的新功能)

Describe Feature (描述功能)

Hi Goravel Team,

I’d love to volunteer to help improve the Goravel documentation UI to make it more appealing and user-friendly.

Input / Wishes:

Are there any design or layout preferences you’d like to see?

Would you be open to rewriting the current docs using FumaDocs to take advantage of its modern features?

Goal:
Enhance readability, navigation, and overall look while keeping the content accurate and helpful.

Looking forward to your thoughts and suggestions!

Again thank you everyone for this great work !

[hwbrzzl]

Hey @livghit Thanks in advance, it's great to improve the Goravel documentation UI. The current document framework is VitePress. There seem to be no big differences between VitePress and FumaDocs. Do you prefer any specific features in FumaDocs, please? VitePress supports setting customized themes as well, not sure if we can optimize the UI via it.

[livghit]

Hey, thanks for the quick response! Totally understand.

I’m personally a bit more in favor of FumaDocs because of the cool built-in components and nice design elements, like better navigation structure, improved sidebar handling, polished dark/light modes, and MDX support instead of plain Markdown. These could make the docs feel more modern and save some setup time.

That said, if you’d prefer to stick with VitePress, no problem at all! I can focus on polishing the UI through custom theming instead. I fully respect your decision either way.

[hwbrzzl]

Got it, we just switched the document framework to VitePress from VuePress, and VitePress can basically meet our needs. So I think we don't need to spend much time switching the framework. And it would be better to optimize the home page or other components via the customized themes.