Improve Documentaion: Lack of Structured Documentation Makes it Difficult for New Developers to Learn Gin

gin-gonic / gin

Gin is a HTTP web framework written in Go (Golang). It features a Martini-like API with much better performance -- up to 40 times faster. If you need smashing performance, get yourself some Gin.

https://gin-gonic.com/

MIT License

79.11k stars 8.03k forks source link

Improve Documentaion: Lack of Structured Documentation Makes it Difficult for New Developers to Learn Gin #4067

Open saramsh-mdit opened 1 month ago

saramsh-mdit commented 1 month ago

Issue:

Unorganized Documentation: The documentation seems scattered across various pages, making it difficult to follow a structured learning path. This leads to confusion for a beginner as there is no clear guide on moving from basics to advanced topics.
No Step-by-Step Guides: There's no step-by-step guide that walks developers through building a full application, which many new users would benefit from.

YlanzinhoY commented 1 month ago

I strongly agree with this! I have a case where my leader wants to use Gin, but the documentation is much more difficult than Fiber or Echo.

lllxh commented 1 month ago

Agree. Newcomers can only learn through examples due to a lack of api docs, making it hard to fully understand the framework.

appleboy commented 4 weeks ago

https://gin-gonic.com/docs/quickstart/ We can improve the documentation.

YlanzinhoY commented 3 weeks ago

How about using NestJS's documentation as a source of inspiration? @appleboy