-
Notifications
You must be signed in to change notification settings - Fork 8
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
Examples needed #9
Comments
Hi James, I'd be very happy if you could make a PR to improve the docs. More examples would be a good idea overall. As for the DB management, I don't see any non-rails equivalent that are missing, can you clarify what you would be expecting to see? Thanks, |
Hi Nico, Thanks for responding and for all the work that you've put into NoBrainer. I'd love to chip in and help with the docs, if only I could get properly up and running first :) I've not given up and have things working ok - just been a little harder to piece things together without examples to go on. I am experienced in php, java, python, node js and more but have only recently had to pick up ruby so to me the nobrainer docs feel a little like being asked to learn Mandarin with only a Mandarin dictionary. What's missing is context. Recipes and examples for all methods would be wonderful and make the whole process so much quicker and frictionless. I understand this would be no small undertaking and whenever I feel confident enough that I understand something well, then I'll make a PR asap. |
no worries :) feel free to ask questions if there are things that are unclear, even questions that you think are basic. |
Nobrainer is awesome. Clearly a lot of work has gone into it. The Docs are pretty good too but are rather thin on examples. The realtime recipe is good but all the other sections could use full examples too. Like the serialization section, which is particularly light on detail, instead just waving a hand toward the active model logic. Just a couple of simple example models using nobrainer and how they would serialize along the lines of the docs on the active model page here would be a massive improvement : http://api.rubyonrails.org/classes/ActiveModel/Serialization.html
Also always providing example alternatives to those not using Rails would be super helpful. For example the db management page http://nobrainer.io/docs/db_management/
Also links to any additional helpful resources, tutorials or talks on using nobrainer would be a welcome addition.
The text was updated successfully, but these errors were encountered: