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

Documentation #196

Open
Betryx opened this issue Jul 30, 2022 · 3 comments
Open

Documentation #196

Betryx opened this issue Jul 30, 2022 · 3 comments

Comments

@Betryx
Copy link

Betryx commented Jul 30, 2022

the documentation doesnt describe any of the functions, classes or methods in it.
The only thing that the documentation gives you, is examples which you have to understand by yourself ehich isnt the point.
A documentation must be descriptive, clear, show every single aspect of the package WITH expamples which this one isnt doing.
The documentation is poorly written and unclear.
You should consider refactoring the documentation abt the framework

@Azevedo-Erick
Copy link

I agree, and if it is interesting for the project to internationalize the documentation, I would like to help translate it into Brazilian Portuguese

@raihaninfo
Copy link

I agree, and if it is interesting for the project to internationalize the documentation, I would like to help translate it into Brazilian Portuguese

I would like to help translate it into Bengali

@lloy0076
Copy link

lloy0076 commented May 29, 2023

https://github.com/gin-gonic/gin/blob/master/docs/doc.md [accessed at 6PM EST on 29 May, 2023 is better than https://gin-gonic.com/docs/ which is almost entirely devoid of anything but the examples and quick start.

It's honestly NOT a good start to using the framework.

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