Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
saramsh-mdit opened this issue Oct 7, 2024 · 4 comments

Comments

@saramsh-mdit
Copy link

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
Copy link
Contributor

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
Copy link

lllxh commented Oct 20, 2024

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

@appleboy
Copy link
Member

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

@YlanzinhoY
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants