-
Notifications
You must be signed in to change notification settings - Fork 90
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 Documentation #212
Comments
I agree @odalysadam , it could be improved a lot. Would you perhaps create a pull request with what you would like to see? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
So just a friendly hint and maybe I'm not having the brightest day, but without much prior knowledge to the topic of json:apis I found your documention rather hard.
You get very much into the Initializer and the advanced features, but skip the basic parts like the Model defining process and how the attributes get mapped. (Having a "post" as a type here is just a tad misleading btw.)
If you could answer simple questions in your documentation like - "What are the parameters for those functions define, create etc.?", "Is it possible to define multiple models?", "Does update use PUT or PATCH?", "Can you define a Model as Read Only?" and I'm sure there's more - out of the box, you would give people a much easier start into using your project instead of looking elsewhere. Convenience is key. Make your project great again.
Much love
The text was updated successfully, but these errors were encountered: