gobuffalo / docs

The source for the Buffalo website
https://gobuffalo.io
MIT License
112 stars 153 forks source link

Improvements on documentations #456

Open fnaysee opened 5 years ago

fnaysee commented 5 years ago

Description

Hi, Thanks for this good project and docs. I think the documentation needs some improvements. First thing i faced was that after reading getting started it left me on the fly. I wasn't knew what to do next! The second one is that there is no list of all the available features in buffalo in one place, so we could understand is it good for our project or not. One problem that i have encountered in windows was that mysqldump was not in path, and it was giving an error which wasn't easy to understand, please somewhere mention that we need to add the mysqldump to our os paths. Also please add a page or improve an available page to completely explain how to start using commands for generating resources, models and migrations in one place and links to pages that explain what is that tool or language and how to use it. For example when you speak about fizz please also add a link to the page that contains some sample fizz codes, doing so someone like me who is new to go and buffalo can easily follow the instructions and start his project. Currently it was so boring for me to check if the framework has support for oauth2 or not? are there any pre built user management system like what we can see in laravel (for php) or not.

And are there any commands to auto generate migrations, models, controllers and etc..

Although finally i found answers to some of my questions by googling but it would be very nice if the docs drive me to the right place.

Again thanks for the good project.

lukasschlueter commented 5 years ago

Hi, thank you for your feedback!

It sounds like you already have some quite concrete ideas about that, would you like to add a PR? Having experienced some difficulties with the docs yourself, you're in the best position to improve it, as you know first hand what could need some work.

The documentation is located at https://github.com/gobuffalo/gobuffalo.

I was planning on creating a repo with some examples for various topics for some time, maybe it's time to work on that now.

fnaysee commented 5 years ago

Sorry i wasn't knew docs has separate repo. Although I don't have deep knowledge on using git but i try helping when i have free time.