search

gin-gonic / website

Official website and document for Gin
https://gin-gonic.com/
MIT License
122 stars 211 forks source link

migrate website to Astro. #289

Open imlargo opened 2 months ago

imlargo commented 2 months ago

Fixes #288

This PR fully migrates the Gin website and documentation from Hugo to Astro using the Starlight template (Docs here ) .

The new implementation fixes several issues the site previously had, such as problems with search functionality, language switching, broken interface, and more. Also, a fresh, modern, well-structured and visually appealing website makes onboarding easier for new developers by making documentation more accessible and understandable, also improves perception and trust in the framework by projecting a modern and reliable image, the site could make a difference in attracting new developers and improve overall developer experience. 🩵

The migration maintains the same folder structure for documentation to ensure consistency. Additionally, it is fully compatible with GitHub Pages for seamless deployment (But i think it’s necessary to have a test deployment using the Gin domain to ensure everything is deployed correctly). Plus, I’d be happy to maintain the new site moving forward to keep it up to date!

Fork: https://github.com/imlargo/gin-website

Preview (Currently, my deployment is on Vercel, but it is compatible with GitHub Pages.) https://gin-website.vercel.app/

AdityaMayukhSom commented 4 weeks ago

The new website looks really good, and it has the polish, but I think the documentation needs to be thoroughly updated as most of the examples still has only code examples without any explanations, and no API documentation is provided either.